Giter Club home page Giter Club logo

api-nodejs-example's Introduction

api-nodejs-example

basic example api nodejs with a begin configurations.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

stable current version of node, npm, yarn and database postgresql

Installing

A step by step that tell you how to get a development env running

First

Clone the project

Second

Execute `yarn` for installing dependences

Third

Duplicate `.env.example` to create `.env` with your basic configs

Finishing

Execute `yarn dev` for executing api
Execute `yarn test` for testing api

Built With

  • Expressjs - Fast, unopinionated, minimalist web framework for Node.js.
  • Sucrase - Sucrase is an alternative to Babel that allows super-fast development builds.
  • Eslint - Find and fix problems in your JavaScript code.
  • Prettier - Prettier is an opinionated code formatter.
  • Nodemon - Nodemon for reload automatically.
  • EditorConfig - EditorConfig helps maintain consistent coding styles for multiple developers and editors.
  • Sequelize - Sequelize is a promise-based Node.js ORM.
  • Jest - Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
  • Supertest - Super-agent driven library for testing node.js HTTP servers using a fluent API.
  • Factory Girl - A factory library for node.js and the browser inspired by factory_girl.
  • Faker - generate massive amounts of realistic fake data in Node.js and the browser.

License

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

api-nodejs-example's People

Contributors

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