Getting Started: Developers

Guidelines

1. To start developing, clone this repository

$ git clone git@github.com:VITCMUN/munverse.git
$ cd munverse

2. Create an env file in the directory

$ touch .env
$ cat <<EOF >> .env
MONGO_USERNAME=root
MONGO_PASSWORD=password
MONGO_DB=munverse

MONGO_EXPRESS_USERNAME=root
MONGO_EXPRESS_PASSWORD=password

MUNVERSE_EVENT_NAME=VITCMUN
MUNVERSE_EVENT_URL=/media/events/vitcmun.png
MUNVERSE_COUNCIL_NAME=AIPPM
MUNVERSE_COUNCIL_URL=/media/councils/aippm.png
MUNVERSE_ADMIN_USERNAME=admin
MUNVERSE_ADMIN_PASSWORD=password1
MUNVERSE_ADMIN_URL=/media/profile/admin.png
EOF

More about the environment variables can be found in Using the official image

3. Start the containers

./sd

You're good to go now! Any changes in the code will be reloaded using nodemon automatically. Note, node_modules need not be installed in your system. They will be automatically installed in the container which runs your code. The app will be available at http://localhost and Mongo-Express, a UI for MongoDB, will be available at https://localhost:8081.

Common commands

command	use
./sd	Start the containers
docker containers ls	To view all containers
docker exec -it <container-id> /bin/bash	To start bash in a container
./std	To stop the containers
docker volume rm munverse_dbdata	To remove MongoDB's data