Backfriend is a BackEnd test (RESTful API) for Geek Development in Medellín, Colombia; a version continued of Graphriend Mini Social Network . This project use Koa2 (from scratch): a fast and lightweight framework for NodeJs.
In order to use Backfriend, you must have the following installed:
To install Backfriend, simply enter the below in the terminal window:
$ git clone https://github.com/mirabalj/backfriend.git your-projectTo install the dependencies, enter the following in your terminal:
$ cd your-project
$ npm install
This will install the Backfriend components into the your-project directory.
Exist a file named config.js in the server directory. This file should contain:
port = 3000
mongodbUri = 'mongodb://localhost/your-database'
baseApi = 'base-name-for-api-rest'
secretKey = 'YourSecretKey'
To start the app, make sure you're in the project directory and type npm start into the terminal. This will start the Node server and connect to MongoDB.
You should the following messages within the terminal window:
The server is running at port 3000...
Next, open your browser and enter http://localhost:3000/. Congrats, you're up and running!
This is an open-source project, and contributions are always welcome!
- Add Unit Tests.
- Separate logic functions from routes? Can be.
- Check Validations of logic business and possible bugs.
- Any idea to add quality and performance to application.
16 hrs 4 mins 16 secs and counting... check in Wakatime
- Jinme Mirabal - All the work, a lot - Portfolio in Codepen.io
MIT License. Click here for more information.