Welcome to TinyTasks, the most basic task management app in the whole wide world - no fancy UI and a very limited set of features. Fortunately, you are here to save the day and improve parts of TinyTasks. Feel free to focus on a single feature or aspect of the application. You can find a list of open issues in the issue section of this repository.
The application consists of a frontend and a backend. Both can be started separately. The frontend is Angular based and the backend is based on Spring Boot.
Before you can start developing you need to set up your development environment. You can find good and clear instructions on the Angular website in the Quickstart guide. The backend requires a PostgreSQL database server that is provided by a Docker container. Thus, Docker is required. You can find the information you need to set up the runtime environment on the Docker website under Get Started.
The fronted was generated with Angular CLI. Run yarn to install the
dependencies for the app. You can also add new dependencies via yarn add. Run yarn start for a dev server.
Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
To run the dev server without starting the backend use yarn start-local. The application will then store its
data in the browser's local storage instead of sending the data to the backend.
Run yarn lint to lint your application and yarn test to execute the unit tests via Karma.
The application is tested using Cypress. To execute the end-to-end tests run yarn e2e
or yarn e2e-local respectively.
The backend was generated with Spring Initializr. Run docker-compose up -d to launch
the PostgreSQL docker container. Run ./gradlew bootRun for a dev server. The server is available under http://localhost:8080/.
Run ./gradlew test to execute the tests.
As you can see, there's a lot to do. Just pick one of the issues and start coding. Also, do not hesitate to contact us if you run into any problems. We are here to help.
Simply start by forking this repository and working on TinyTasks. Please create a pull request after finishing your work.