Project has been archived

This project has been archived and is no longer maintained. The development has stopped and the project is not in use anymore. If you want to continue the development, feel free to fork the project and continue the development on your own.

Table Of Contents

• Roadmap
• Contributing
• License
• Project Setup
• Contributors

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

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

• If you have suggestions for adding or removing projects, feel free to open a discussion to discuss it.
• Please make sure you check your spelling and grammar.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes following the Conventional Commits specification (git commit -m 'feat(pwa): add amazing-feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

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

Project Setup

Requirements

This project contains the source code for backend (e.g. /apps/api) and frontend (e.g. /apps/pwa). Your local setup must meet the following requirements to get the whole ecosystem (api, apps, databases) running on a local machine.

Node.js >=16.0.0 <= 17.0.0 is required for the javascript tooling and to build the backend and frontend code. Docker >= 19.03.0 is required to host local database instances.

Get Started

Read our Getting Started Guide to get everything up and running. If you follow all getting started steps, you'll be able to explore the local running app, the database or start contributing to this awesome project!

Neo4j Dashboard

The Neo4j Dashboard will be available under http://localhost:7474/browser/. Use it to verify database changes you make when working with our neo4j api service.

Parse Dashboard

The Parse Dashboard will be available under http://localhost:4040. Use it to manage data in our mongodb. Never connect directly to the mongodb instance to change data!

Development server

• Run nx serve-ssr pwa to start the pwa dev server with ssr. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
• Run npm run start:cloud and nx serve api to start the api dev server.

Build

Run npm run build to build the project. The build artifacts will be stored in the dist/ directory.

Running unit tests

Run ng test pwa to execute the unit tests via Jest in our frontend.

Run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests

Run ng e2e pwa-e2e to execute the end-to-end tests via Cypress. This command will also run ng serve pwa before cypress tests are executed!

Run nx affected:e2e to execute the end-to-end tests affected by a change.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Pascal M 📆 💼 💻 📖 🎨 🚇

Maximilian von Lindern 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!