Git Product home page Git Product logo

backend-omnistack's Introduction

OmniStack's Back end API

The back end application for TinDev (The dev Tinder) developed using Node.js and Javascript.

See more details in the main repository.

Important: we commited publicly the MongoDB connection to enable an easy configuration and setup for anyone whose want to run the application. But we strongly advise you against this practice. Prefer using dotenv to keep your configuration and variables as it should be - local and SECRET!

Environment setup

  • Install Node.js (v10.16.1 or above) via package manager here
  • Install Yarn for Node package managment instead of npm. Note: install Yarn via package manager like the step before
  • Be happy! :D

Tips

Running the service

You will need to run the command yarn (First time only) to install the Node dependencies that will be stored under node_modules folder.

With the environment set and the dependencies in place, you just need to run the service. Each environment has its own way of starting the service:

  • DEV - run yarn dev to start the server service

Important: After running the command, to test if the service is up and running, try accessing the service root path. Eg: http://localhost:3333/

Dependencies

Roadmap

The 2020 API roadmap

  • User registration endpoint
  • Endpoint to list all profiles to match
  • Like action
  • Dislike action
  • Handle error cases using HTTP codes
  • Endpoint to list all users
  • Authentication via token instead of our current user's ID header that is insecure
  • Enable security levels using user permissions to prevent unauthorized calls. Each endpoint has a security level and a user can only succeed if he has the required permissions
  • Continuous integration with CircleCI ๐Ÿ˜
  • Add a Redis DB to store the mapping of userId and WebSockets in order to transform the server to stateless

backend-omnistack's People

Contributors

adrianokerber avatar dependabot[bot] avatar

Stargazers

 avatar

Watchers

 avatar  avatar

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.