README.md

likelion-mju.com

📖 Introduction

This project is a site for applying Likelion at MJU Seoul

🏁 Getting started

1. git clone

First of all, clone this repository

$ git clone https://github.com/likelionmju/mjuseoul.likelion.org.git

2. create virtual environment

Second, prepare a virtual environment with the django and several packages

$ python -m venv venv

The name of virtual environment is defined by "venv"

3. activate virtual environment

$ source venv/scripts/activate # for windows
$ source venv/bin/activate # for mac or linux

4. install pip packages

$ pip install -r requirements.txt

The required packages are defined in the requirements.txt file.

$ pip freeze > requirements.txt

If additional packages are installed, the following commands should be executed.

5. change git branch

first time, you must change master branch to other branch

$ git checkout <branch_name> # backend or frontend

Insert 'backend' or 'frontend' instead of <branch_name>.

Git command

$ git pull origin <branch_name>
$ git add .
$ git commit -m "messages"
$ git push origin <branch_name>

Insert 'backend' or 'frontend' instead of <branch_name>.

🧐 What's inside?

.
├── .config
├── account
├── config
├── page
├── .gitignore
├── manage.py
├── README.md
└── requirements.txt

1. /.config: setup files to deploy
2. /account: account app
3. /config: setup files in project
4. /page: page app
5. .gitignore: define what should be ignored in git
6. manage.py: django command-line util
7. requirement.txt: list of pip-packages to install

📝 License

This project uses the MIT License