viniqrz / instagram-clone-backend

👨‍👨‍👧‍👦 Social Network API. Made with Mongoose, Express and MongoDB. [Clean-Architecture] [SOLID]

Instagram Clone (Social Network API v1)

An open-source social network API, based on instagram features.

Pre-requisites

• Node.js (14.18.1 or higher)
• NPM (6.14.15 or higher)

Run

Make sure you create your .env file using .env.example as a template

Install Dependencies

  npm install

Start Development Server

  npm run dev

Generate Build

  npm run build

Tips for those who want to contribute

• Make sure to lint all your pull requests before push
• API is currently tested manually, but Jest is installed, feel free to make automated tests
• A repository layer will be necessary in order to test it heavily

Tips for those who want to consume

• Feel free to host or fork and use in your own project
• You can use it as it is, or just a template to build more features
• If you need any help, contact me on: [e-mail]
• There's no official documentation, but there's a insomnia file i used to test it, just import it if u need some guidance on your requests