README.md

IEEE NITK Corpus

A Django based web application to manage all things IEEE NITK.

Setup Instructions

1. Run the following command to create a copy of the environment file. Change the environment variables as necessary in the copied file.

cp env.example .env

2. In another terminal window, run docker compose

docker compose up

If you have already built the project before, you should rebuild it before getting the services up. Use the following for the same:

docker compose up --build

Note: Auto-reload for Tailwind on Windows only works on WSL, and not on the Windows filesystem. If you are using the Windows filesystem, you'll have to manually restart the jstoolchain container.

To stop the containers, just bring the services down.

docker compose down

To remove all the previous data as well, you will have to remove the volumes too. You can do that by appending -v to the down command.

For more guidance, refer to the Docker Compose documentation.

Production Setup

For production setup, use the production docker compose file.

npx tailwindcss -i ./templates/static/css/tailwind.css -o ./templates/static/css/tailwind-min.css --minify
docker compose -f prod-docker-compose.yml up --build

Contributing

Refer to the contribution guidelines for more information about how to set the project locally for development and contribution.

--- Made and maintained by the Corpus team, IEEE NITK ---