Website for learning how to code from unique perspectives
This project uses Nx to manage the monorepo and npm as the package manager. To use nx commands, install nx CLI globally:
npm i -g nx
Navigate to codewit.us/codewit/ and create a .env file with the following content:
# Frontend
YT_KEY='YOUR YOUTUBE API KEY'
YT_CHANNEL_ID='YOUR CHANNEL ID'
# Backend
GOOGLE_REDIRECT_URL="GOOGLE AUTH REDIRECT URL"
GOOGLE_CLIENT_ID="YOUR CLIENT ID"
GOOGLE_CLIENT_SECRET="YOUR SECRET"
COOKIE_KEY="ANY ALPHANUMERICAL STRING"From the codewit directory, you can run nx commands
Running front end: nx serve client
Running back end: nx serve api
Running both frontend and backend using docker-compose with watching for file changes enabled: docker-compose up -d && docker compose watch.
This will start the frontend, backend and the db in separate containers and watch for file changes in the codewit directory.
To stop the containers, run docker-compose down, as doing Ctrl+C will not stop the containers. it will stop the watcher but the containers will still be running.
To view logs from each container use docker logs -f <container-name>.
The codewit.us/codewit/api/src/scripts/seed-admins.ts file is used to seed the database with admin users. The script is run using the command npm run seed-admins.
For example to seed an admin users with the emails abc@example.com and def@example.com, run the following command:
npm run seed-admins -- --admin abc@example.com def@example.comdo note that we also need to export the following environment variables for the seeding to work, for example:
export DB_HOST=localhost
export DB_USER=codewitus_user
export DB_PASSWORD=12345
export DB_NAME=codewitus_db
export DB_PORT=5432See the contributing guide.
An overview of the features of the software is available in our roadmap