Skip to content

theParadox42/EFE-Backend

Repository files navigation

Escape From Earth Backend

Build Status DeepScan grade

This is the backend part of escape from earth that handles the community section of it. Changes are currently underway. v1 is the version in use, but is about to be deprecated. v2 is about to be released and brings a lot of great changes including user authentication, liking, disliking, and flagging levels, plus security boosts. The versions are available at escape-from-earth.herokuapp.com/v1 OR v2

A api documentation is not released, so if you feel like you want to understand it, just contact me and I can guide you from there.

You are welcome to submit an issue or open up a pull request if you want.

Feel free to contact me here if you have any questions or concerns.

Setting Up On a Local Device

  • Clone or download however desired onto a computer, with a terminal
  • Make sure node.js and npm are installed
  • Run npm install
  • Open the file .env with your favorite file editor
  • Fill in the MONGO_CONNECTION with a string that connects to a database