Git Product home page Git Product logo

backfriend's Introduction

Backfriend

Overview

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.

Quick Start Guide

Prerequisites

In order to use Backfriend, you must have the following installed:

Installation & Startup

To install Backfriend, simply enter the below in the terminal window:

$ git clone https://github.com/mirabalj/backfriend.git your-project

To 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.

Local Environment Variables

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'

Starting the App

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!

Contributing

This is an open-source project, and contributions are always welcome!

TODO

  • 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.

Time of development

16 hrs 4 mins 16 secs and counting... check in Wakatime

Credits

License

MIT License. Click here for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.