Giter Club home page Giter Club logo

crypto-app-backend's Introduction

crypto-app-backend

Quick introduction

This repository contains a Node.js app that acts as a backend service with a restful API and WebSockets. It can be used with this UI https://github.com/Nachox07/crypto-app-frontend in order to visualize the changes and data. The tech stack used is the following:

  • Express with Typescript
  • MongoDB as NoSQL database
  • Celebrate and Joi for request validation and error handling
  • Socket.io as websocket server

Installation

Firstly all the dependencies need to be installed, as this is a JS project node is necessary plus a dependency installer, the preference here is yarn

Once these tools are installed you need to run on the project folder for dependencies installation:

yarn

MongoDB is an important dependency and it needs to run as a local service, here are the docs https://docs.mongodb.com/manual/installation/

Once it is running DB needs to be populated to show some data by using:

yarn db:generate

Now we can check if the population was succeeded by doing a simple query on the new db created crypto-app-db-development on the accounts collection like this:

$ use crypto-app-db-development

$ db.accounts.find({})

For data structure reference, please check the types on src/accounts/types.ts

Running the app

The app can be running in two different environment, the domain and port will be http://localhost:8080.

Development mode

Nodemon will be pending of file changes and it will reload the app.

yarn server:dev

Production mode

App is compiled to ES5 and it starts running.

yarn server

Testing

Types

yarn test:types

e2e

The testing is performed for now by the Cypress suites included on the Frontend project mentioned above

crypto-app-backend's People

Contributors

nachox07 avatar dependabot[bot] avatar

Watchers

 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.