Anavrin

Simple tracking & simulation for your portfolio

Stack

Frontend Framework - Next JS
CSS Framework - Tailwind CSS
Frontend Components -Mantine components
Frontend API connection - React Query
Backend API - Next.js API Routes
Auth - NextAuth.js
Hosting - Vercel
Testing - Jest

Note

Project uses qoomon/git-conventional-commits (refer doc) to use this you must set git hook directory to .githooks using git config core.hooksPath '.git-hooks'.

Getting Started

Setting up local env

This is how your local env.local file should look like in root of the project.

ALPHAVANTAGE_API_KEY=<ALPHAVANTAGE_API_KEY>

GOOGLE_CLIENT_ID=<GOOGLE_CLIENT_ID>
GOOGLE_CLIENT_SECRET=<GOOGLE_CLIENT_SECRET>

MONGODB_URI=mongodb+srv://<MONGO_APP_NAME>:<MONGO_PASS>@cluster0.ieyta.mongodb.net/<MONGODB_DB>?retryWrites=true&w=majority
MONGODB_DB=<MONGODB_DB>

NEXTAUTH_URL=http://localhost:3000/api/auth
NEXTAUTH_SECRET=<NEXTAUTH_SECRET>

VAPID_PUBLIC_KEY=<VAPID_PUBLIC_KEY>
VAPID_PRIVATE_KEY=<VAPID_PRIVATE_KEY>
VAPID_SUBJECT=test:test@test.app

ENV Keys	Description	Links to get Key
ALPHAVANTAGE_API_KEY	Required for add/search stock Modal used in portfolio page.	alphavantage-api-key
GOOGLE_CLIENT_ID / GOOGLE_CLIENT_SECRET	Required for loggin-in and is the primary Auth provider currently	Guide to creating Google Auth Credentials
MONGODB_URI / MONGODB_DB	Required for loggin-in and is the primary database	Guide to creating MogoDB Atlas Cluster Credentials
VAPID_PUBLIC_KEY, VAPID_PRIVATE_KEY, VAPID_SUBJECT	Required for creating and sending webpush notifications	In the terminal, run `npx web-push generate-vapid-keys`. Copy the private key and public key values.
NEXTAUTH_SECRET	Required in production	run `openssl rand -base64 32` or visit this site.
MERGENT_APIKEY	Required to schedule notifications and run cron jobs	get API key from Mergent site.
MERGENT_AUTH_TOKEN	Required to authorize cron jobs	run `openssl rand -base64 32` or visit this site.

After setting up the env.local file, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

Notes

running individual Tests: npm test -- -u -t="test name";
To Debug, run npm run debug visit chrome://inspect
ToPersistence() means to massage data such that it can be sent to the database.
ToDTO() means to massage data such that it confroms to API response.
repositories => is analogous to Models.
controller is usually created using 3 Classes/files
1. the Nextjs API endpoint -> A Handler is created and objects are initialized. (The object for createController, the UseCase and all the repositories passed to the UseCase)
2. The CreateController class handles controller functions such as Request params validation and mapping to DTO.
3. The UseCase handles to Application logic of the controller.
ngrok http --domain=amazed-saving-lynx.ngrok-free.app 3000