rafaelfborges / devradar-backend

Backend for the DevRadar application.

Home Page:http://devradar-osweek-backend.herokuapp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Welcome to DevRadar - Backend

Version Documentation Maintenance License: MIT

Backend application developed during the Week Omnistack 10 of Rocketseat. Two other applications are also part of this project:

Demo

DevRadar - Backend

Prerequisites

  • node >=12.14
  • yarn >=1.21

Dependencies

  • axios@^0.19.1
  • cors@^2.8.5"
  • dotenv@^8.2.0
  • express@^4.17.1
  • mongoose@^5.8.7
  • socket.io@^2.3.0
  • swagger-ui-express@^4.1.3

Development dependencies

  • nodemon@^2.0.2

Install

$ yarn install

Usage

$ cp .env.example .env
$ yarn start

Or running dev

$ yarn dev

Database configuration

For the project you need a moogodb connection, you follow these steps below:

  1. Create an account on MongoDB Cloud
  2. Create a mongo db cluster
  3. Create a database with name week10
  4. Create a user to database connection week10 with your password
  5. Get URL connection on cluster configuration
  6. Replace MONGO_URL_CONNECTION key on .env eg: mongodb+srv://:@node-store-sqexu.mongodb.net/week10?retryWrites=true&w=majority

Author

👤 Rafael Borges

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Rafael Borges.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator

About

Backend for the DevRadar application.

http://devradar-osweek-backend.herokuapp.com/

License:MIT License


Languages

Language:JavaScript 100.0%