Skip to content

helsingborg-stad/gdi-aboutme-server

Repository files navigation

MIT License

Logo

GDI About Me Server

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

About Me services for GDI.

(back to top)

Getting Started

# install dependencies
yarn

# run tests
yarn test

# run tests and report coverage
yarn coverage

# start web server
yarn start

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

# start with debugging output
DEBUG=* yarn start

(back to top)

Prerequisites

(back to top)

Configure environment variables

In order to run, some environment variables must be defined. This is easiest to do by

  • ensuring there exists a local .env in the project root
  • copy content from .env.example and change values to what gives meaning

(back to top)

GraphQL explorer

Assuming you have configured a fallback user (thus not requiring a JWT Bearer token), https://cloud.hasura.io/public/graphiql?header=content-type:application/json&endpoint=http://localhost:3000/api/v1/aboutme/graphql should give you some satisfaction.

(back to top)

Integrations

Roadmap

  • Expand model
  • Support MongoDB as master
  • Change notifications via AMQP

(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)