Giter VIP home page Giter VIP logo

backend's Introduction

Kod3rs Store (Backend)

This is the back-end repository of the Kod3rs Store project. For the front-end repository please see this link To read the full documentation see our notes in Notion and visit our website Website

Kod3rs Store is developed using Nodejs connecting a MySQL database.

This server implements security using Passport js using Json Web Tokens.

Getting Started

To get the project you should create a git in your local computer

git init

Clone the repository

git clone https://github.com/kod3rsStore/Backend.git

Prerequisites

To run this project please use the following command:

node

If you want to run your project in a container you need:

docker 
docker-compose

Installing

To install the project you should execute the next commands.

Install

npm intall

Execution

npm run dev

End with an example of getting some data out of the system or using it for a little demo (This will be added when we have the seed scripts)

Running the tests

npm run test

Running the tests with coverage report

npm run coverage

API documentation

Start the server npm run dev to get access to documentation.

Go to: http://localhost:3000/api/documentation/swagger/

Built With

  • @hapi - The most powerful schema description language and data validator for JavaScript.
  • bcryptjs - Used to crypt information between servers
  • braintree - The Braintree Node library provides integration access to the Paypal Gateway.
  • dotenv - that loads environment variables
  • express - Fast, unopinionated, minimalist web framework for node.
  • jsonwebtoken - Used to generate server-to-server authentication
  • multer - Multer is a node.js middleware for handling multipart/form-data
  • mysql - Used to connect with the Mysql Database
  • nanoid - A tiny, secure, URL-friendly, unique string ID generator for JavaScript.
  • Passport - Used to authenticate users in a simple form and with Google
  • stripe - The Stripe Node library provides convenient access to the Stripe API

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

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.