diff --git a/.gitignore b/.gitignore index a2e04e4..cce46f5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,12 @@ node_modules -.env \ No newline at end of file +# 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 \ No newline at end of file diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..79e80ed --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,3 @@ +{ + "recommendations": ["esbenp.prettier-vscode"] +} \ No newline at end of file diff --git a/.vscode/settings.json.default b/.vscode/settings.json.default new file mode 100644 index 0000000..e31c8fe --- /dev/null +++ b/.vscode/settings.json.default @@ -0,0 +1,7 @@ +{ + "editor.defaultFormatter": "esbenp.prettier-vscode", + "[javascript]": { + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": true + } +} diff --git a/README.md b/README.md index afdf51b..24a1eac 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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.