Skip to content

Commit

Permalink
Update README with instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
anirudhprabhakaran3 committed Dec 25, 2023
1 parent 186bd32 commit 66c0b53
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,31 @@ 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.
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. Run docker compose
2. You'll need to setup the JS Toolchain, so that Tailwind and DaisyUI work properly. Install the version of `node`
mentioned in the `.tool-versions` file.
After installing `node`, do the following.

```shell
cd corpus/
npm install
npx tailwindcss -i ./templates/static/css/tailwind.css -o ./templates/static/css/tailwind-min.css --minify
```

3. 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:
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
Expand All @@ -28,18 +40,22 @@ 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.
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
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.

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 ---_

0 comments on commit 66c0b53

Please sign in to comment.