Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mayank0255/stackoverflow-clone-backend

Backend code of the Stackoverflow Clone project. Built using Express, Node, MySQL, and Sequelize
https://github.com/mayank0255/stackoverflow-clone-backend

api backend database docker express expressjs hacktoberfest javascript mern mern-stack mysql nodejs rest-api sequelize sql stack stackoverflow

Last synced: about 1 month ago
JSON representation

Backend code of the Stackoverflow Clone project. Built using Express, Node, MySQL, and Sequelize

Awesome Lists containing this project

README 

        
![Stackoverflow-Clone-Backend](https://socialify.git.ci/Mayank0255/Stackoverflow-Clone-Backend/image?font=Source%20Code%20Pro&forks=1&issues=1&language=1&owner=1&pattern=Charlie%20Brown&pulls=1&stargazers=1&theme=Dark)



[![Version](https://img.shields.io/static/v1?label=version&message=2.0.0&color=blue)](https://shields.io/)

[![NPM](https://img.shields.io/static/v1?label=npm&message=6.8.5&color=blue)](https://shields.io/)

[![NODE](https://img.shields.io/static/v1?label=node&message=10.12.8&color=success)](https://shields.io/)

[![MYSQL](https://img.shields.io/static/v1?label=mysql&message=8.0.10&color=blueviolet)](https://shields.io/)

[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://shields.io/)



### [🌐 Website](https://stackoverflow-clone-client.vercel.app)  |  [📹 Demo Video](https://www.youtube.com/watch?v=bUAAgfGOfYg)



### API Hosted On

- __[stackoverflow-clone-api.onrender.com](https://stackoverflow-clone-api.onrender.com) (Primary)__

- __[stackoverflow-clone-backend.herokuapp.com](https://stackoverflow-clone-backend.herokuapp.com)__



As the name suggests, this project is a clone of a famous Q/A website for professional and enthusiast programmers built solely by me using a completely different stack.



This repo consists of the Backend code of the project, the backend code is in __[Stackoverflow-Clone-Frontend](https://github.com/Mayank0255/Stackoverflow-Clone-Frontend)__



## My Tech Stack (MERN)



#### Front-end



- Front-end Framework: `React.js (with Redux)`

- Styling: `SASS` and `BOOTSTRAP`



#### Back-end



- For handling index requests: `Node.js with Express.js Framework`

- As Database: `MySQL with Sequelize`

- API tested using: `POSTMAN`



## Guidelines to setup



There are two ways to setup the project: manually or using the Dockerfile. Read below for more details:



### Manual Setup



1. Open your local CLI -



   ```

   mkdir Stackoverflow-Clone

   cd Stackoverflow-Clone

   ```



2. Setup the backend code -



   - Create a `.env` file and the format should be as given in `.env.example`.

   - Clone the code & install the modules-



     ```

     git clone https://github.com/Mayank0255/Stackoverflow-Clone-Backend.git

     cd Stackoverflow-Clone-Backend



     npm install

     ```



   - Open your MySQL Client -



     ```

     CREATE DATABASE stack_overflow;

     ```

     NOTE: Don't forget to keep the database name same in the `.env` and here.



   - Run the index `npm start`.



3. Open a new CLI terminal and goto the root `Stackoverflow-Clone` folder you created in the first step.

4. Setup the Frontend code -



   - Clone the code & install the modules-



     ```

     git clone https://github.com/Mayank0255/Stackoverflow-Clone-Frontend.git

     cd Stackoverflow-Clone-Frontend



     npm install

     ```



   - Run the client index `npm start`.



### Docker Setup



The back-end has support for Docker. So if you want to run the back-end in a container, you need do:



- Setup environment variables in `.env` file. Note when you use Docker setup and run the database in localhost (host machine), you need to setup the environment variables for use correct IP of MySQL Database. Please, read [here](https://docs.docker.com/compose/environment-variables/) and [here](https://docs.docker.com/desktop/windows/networking/) for more details.



- Build the Docker image:

  ```

  docker build -t stackoverflowclone .

  ```

- Run the container. For example, if you want to run the container in a new terminal, you can do:

  ```

  docker run -d -p 5000:5000 stackoverflowclone

  ```



The default port of api is 5000. After running the container, you can access the api by typing:



    http://localhost:5000/api/



_Follow the steps properly (manual or Docker) and you are good to go._



## API Endpoints



API is currently hosted on __[stackoverflow-clone-api.onrender.com](https://stackoverflow-clone-api.onrender.com)__ and __[stackoverflow-clone-backend.herokuapp.com](https://stackoverflow-clone-backend.herokuapp.com)__.



You can view and read the API endpoints samples [here](https://documenter.getpostman.com/view/10053385/UVC3kTiG#f02c9fce-5737-4cd6-9d8e-ad48233102c7). This is API documentation for the back-end.



But, if you want use Postman to test the API in local machine, you need to follow the steps below:



- Get the Postman app from [here](https://www.getpostman.com/downloads/).

- Download the Postman collection file in folder "/data/postman_collection"

- Import the collection file in Postman

- **Important:** will be necessary to setup the enviroment with the "VARIABLE"=urlAPI and "INITIAL VALUE"=http://localhost:5000, for example.

- **Remember**: keep the Postman collection updated with the latest API endpoints.



#### Base Url - `{API_URL}/api`



#### Users



- `GET /auth`

- `POST /auth`

- `POST /users/:id`

- `GET /users`

- `GET /users/:id`



#### Posts



- `GET /posts`

- `GET /posts/top`

- `GET /posts/tag/:tagname`

- `GET /posts/:id`

- `POST /posts/`

- `DELETE /posts/:id`



#### Answers



- `GET /posts/answers/:id`

- `POST /posts/answers/:id`

- `DELETE /posts/answers/:id`



#### Comments



- `GET /posts/comments/:id`

- `POST /posts/comments/:id`

- `DELETE /posts/comments/:id`



#### Tags



- `GET /tags`

- `GET /tags/:tag_name`



## Contributing



- Go to [Contributing.md](./CONTRIBUTING.md)



## DEMO



#### VIDEO - [Watch the video](https://www.youtube.com/watch?v=bUAAgfGOfYg)



_Video Last Updated on 7th March, 2022_



#### IMAGES