jarrodlilkendey / 168-hours

168 Hours

Goal of this Project

Practice writing unit, integration and end to end tests using the following technologies:

1. React / NextJS / NextAuth / Prisma / Typescript
2. React Test Library
3. Cypress
4. Jest

Put all tests in a continuous integration continous deployment pipeline using GitHub Actions.

Self host the web application and database using infrastructure as code with Digital Ocean, to gain further experience managing these components in production without relying on managed providers such as Vercel, Supabase or AWS managed databases.

Usage

1. Follow the .env file templates to complete .env, env.local, env.test.local
2. Run with locally npm run dev
3. Run unit tests with React Test Library via Jest using npm run test:ui
4. Run Cypress integration, API integration tests, and E2E tests with npm run build:test then npm run cypress:start

Features

1. Free Time Calculator: Calculate how much free time you have in a week
2. Time Tracker: Track how you actually spend your time
3. Schedule Maker: Create a weekly schedule

Technical Design

1. NextJS + Pages Router + API Router
2. NextAuth for authentication (using email provider as this will not be a commercial project)
3. Prisma for an ORM on top of a Postgres DB
4. Typescript
5. The application will be Dockerized and hosted using Docker Compose on a Digital Ocean VPS
6. PostgresDB self hosted on a Digital Ocean VPS
7. Terraform and Ansible for infrastructure as code and configuration management

Todo

Observability

• Enable OpenTelemetry in Next.js
• Enable OpenTelemetry spans for the webserver request and response
• Enable OpenTelemetry spans for the api request and response
• Enable OpenTelemetry spans for the ORM request and response
• Enable OpenTelemetry spans for the database request and response
• IAC for a Digital Ocean droplet to host the observability and monitoring infra / applications

Security

• Implement security scans including static code analysis, static application security testing (SAST), and dynamic application security testing (DAST)

Infra as Code

• Implement infra as code for a dev and prod environment for both the application server and the database server
• IAC for dev application server
• IAC for prod application server
• IAC for dev database server
• IAC for prod database server
• IAC for cloudflare pointing dev.168hoursapp.com to dev application server and 168hoursapp.com to prod application server
• IAC to configure firewall on the production database droplets to restrict incoming incoming to only the production application server
• IAC for Ubuntu setup security hardening tasks

Scalability

• Migrate from docker compose into kubernetes for hosting the application

Test Automation

• Implement more API tests in Cypress
• Test coverage reporting with Cypress

New Features

UX

• Improve application look and feel