Git Product home page Git Product logo

handsoncoding-back's Introduction

HandsOnCoding Business Logic (Back-End)

This is the business logic REST API for the HandsOnCoding project, an open-source MOOC (Massive Open Online Courses) for multiple programming languages.

Build With

Node Typescript Express Prisma MongoDB Swagger

Getting Started

Prerequisites

In order to run this project you should install Node in your computer.

To have full access to the database, you should enable your computer IP address in the MongoDB cluster.

Installation

  1. Clone the repository
    git clone https://github.com/Esarac/HandsOnCoding-Back.git
  2. Go inside the project folder
    cd HandsOnCoding-Back
  3. Install npm packages
    npm i

Usage

Configuration

In the schema.prisma file, you can define all your schemas and the database provider.

To submit your changes into the database, use the following command:

npm run db-push

For more information, visit the Prisma webpage.

You can also define the:

  • PORT
  • DATABASE_URL

in the .env.development and .env.test files.

Start

To run the REST API, just execute the command:

  • Dev env
    npm start
    # or
    npm run dev
  • Test env
    npm run test

For more information, you can access the API documentation via the route http://localhost:8080/api/v1/docs.

Prisma Studio

Prisma Studio is a visual editor for the data in your database.

To open Prisma Studio, use the following command:

  • Dev env
    npm run ps-dev
  • Test env
    npm run ps-test

Related Projects

Contact Information

Quality Esteban Ariza Acosta (Esarac)

Github LinkedIn Gmail Instagram

handsoncoding-back's People

Contributors

esarac avatar jaimechavarriaga 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.