https://github.com/ieee-nitk/corpus

A Django-based web application for managing all things IEEE NITK!
https://github.com/ieee-nitk/corpus

Last synced: 4 days ago
JSON representation

A Django-based web application for managing all things IEEE NITK!

• Host: GitHub
• URL: https://github.com/ieee-nitk/corpus
• Owner: IEEE-NITK
• Created: 2022-11-22T20:30:21.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-24T18:21:06.000Z (8 days ago)
• Last Synced: 2024-12-24T19:24:11.350Z (8 days ago)
• Language: HTML
• Homepage: https://ieee.nitk.ac.in
• Size: 144 MB
• Stars: 2
• Watchers: 4
• Forks: 9
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# IEEE NITK Corpus

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/IEEE-NITK/corpus/main.svg)](https://results.pre-commit.ci/latest/github/IEEE-NITK/corpus/main)

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.

```sh

cp env.example .env

```

2. In another terminal window, run docker compose

```sh

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:

```sh

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.

```sh

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](https://docs.docker.com/compose/) documentation.

## Production Setup

For production setup, use the production docker compose file.

```sh

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](./CONTRIBUTING.md) guidelines for more information about how to set the project locally for

development and contribution.

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