Skip to content

helsingborg-stad/haffa-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MIT License

Test Status

Logo

Haffa backend

Haffa backend broker för authentication and data
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Acknowledgments

About The Project

This is a project template for GDI server applications. As such, it includes

(back to top)

Integrations

haffa-backend works with different storage and service providers including in memory, disk and MongoDB.

Check out our integration guide for more info.

Getting Started

Configuration

Make sure you have the file .env in your project root. For its contents, refer to samples in .env.example

Build and run

# install dependencies
yarn

# run tests
yarn test

# run tests and report coverage
yarn coverage

# start web server
yarn start

# start server on port 8080 instead of default 4000
PORT=8080 yarn start

# start with debugging output
DEBUG=* yarn start

Run with Docker:

# Replace access_token_from_github with your developer token)
export GITHUB_ACCESS_TOKEN=<access_token_from_github>

# Run Docker
docker-compose up

Testing endpoints

(back to top)

Prerequisites

(back to top)

Roadmap

  • Feature 1
  • Feature 2
  • Feature 3
    • Nested Feature

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

(back to top)