Skip to content

Commit

Permalink
Adds VS Code settings and recommended extensions
Browse files Browse the repository at this point in the history
  • Loading branch information
rodgracas committed Jun 7, 2021
1 parent 59a9c9a commit d1bd606
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 1 deletion.
11 changes: 10 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
node_modules

.env
# Ignore local environment file
.env

### VS Code ###
# Not ignore cliptale default vsscode settings
.vscode/*.default
# Not ignore recommended extensions file
!.vscode/extensions.json
# Ignore everything else inside vscode (user snippets, etc...)
.vscode
3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": ["esbenp.prettier-vscode"]
}
7 changes: 7 additions & 0 deletions .vscode/settings.json.default
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
}
}
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

Automate your Instagram stories clipping using Puppeteer.

## Table of contents

- [Cliptale 📎](#cliptale-)
- [Table of contents](#table-of-contents)
- [Set up](#set-up)
- [Instagram credentials](#instagram-credentials)
- [Instagram profile users](#instagram-profile-users)
- [Install](#install)
- [Run](#run)
- [Next steps](#next-steps)
- [VS Code](#vs-code)
- [Contributing](#contributing)
- [Pull Request Process](#pull-request-process)

## Set up

Open your terminal and run the following commands:
Expand Down Expand Up @@ -51,10 +65,24 @@ npm start
- [x] Run in headless mode
- [x] Add Prettier
- [ ] Add Eslint
- [ ] Create API
- [ ] Write tests
- [ ] Typescript support
- [ ] Create web application

## VS Code

`cliptale` has a `.vscode` folder setup with some default settings and recommended extensions for VS Code editor.

To start using these settings, open your terminal and run:

```bash
# In root
cp .vscode/settings.json.default .vscode/settings.json
```

You can change your `settings.json` as you wish since they will not be tracked on Git. If you want to add some changes to the default settings, please feel free to add on the `settings.json.default` file.

## Contributing

Contributions are welcome 😀 This is my first open-source project on Github, so I would be very grateful to share your thoughts on this project, solve any issues and receive your feedback for improvements or enhancements.
Expand Down

0 comments on commit d1bd606

Please sign in to comment.