Giter Club home page Giter Club logo

backend's Introduction

Express API template

Build Status Coverage Status Maintainability Test Coverage Build status

Live API endpoint: https://express-api-template.herokuapp.com/v1

Read the article here https://www.smashingmagazine.com/2020/04/express-api-backend-project-postgresql/

How to run the app

  1. Clone the repo

  2. Create a .env file at the project root and provide the following environment variables

    TEST_ENV_VARIABLE="some arbitrary string" CONNECTION_STRING="a url pointing to a PostgreSQL database" PORT="port number to serve the files. defaults to 3000"

  3. Open a terminal in the project root and run yarn install to install the project dependencies.

  4. Run yarn test to make sure everything is working correctly.

  5. Run yarn startdev to start the development server

  6. Open http://localhost:3000 or use whatever port you supplied in your environment variable.

  7. Remember to replace the badges with your custom badges

How to test

  1. Run yarn install to install project dependencies
  2. Run yarn test

backend's People

Contributors

chidimo avatar psyfercom avatar dekayphotography avatar

Stargazers

Roy Hodge Jr. avatar

Watchers

Roy Hodge Jr. 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.