Commit a73115da authored by Brian Guadalupe's avatar Brian Guadalupe

Add readme

parent 95b54b6b
# MyMusicList
This is a work in progress as of now...
**IMPORTANT: Please read the contribution guide (`CONTRIBUTING.md`) first before pushing to this repo! Any unnecessary commits to the `master` branch will be immediately reverted.**
## Prerequisites
* Python 2.7/3.4 or later
* `virtualenv` (preferred)
* SQLite3 (for testing)
* Add the `sqlite3` executable in your `PATH`
* MySQL (for the final version)
## Setup
This assumes both Python and Git have been already installed and added to the `PATH`.
1. Clone the MyMusicList repo from `https://gitlab.discs.ateneo.edu/brian/mymusiclist` using Git
* `git clone https://gitlab.discs.ateneo.edu/brian/mymusiclist`
2. Install the latest version of `virtualenv`
* `pip install virtualenv`
3. Setup the Python virtual environment; you can opt to use any name you prefer
* `virtualenv venv`
4. Activate the virtualenv
* *`path\to\venv\`*`Scripts\activate` (for Windows)
* `. `*`path/to/venv/`*`bin/activate` (for Linux/Mac OS)
5. Install Django using `pip` (inside the virtualenv)
* `pip install django`
6. Make sure that the `migrations` folder is empty except for the `__init__.py` file
7. Delete the `db.sqlite3` file if it exists
8. Run the following commands (inside the virtualenv):
* `python manage.py makemigrations core playlist search tag user`
* `python manage.py migrate`
9. Open the `db.sqlite3` file in sqlite3, and run the following commands:
* *`sqlite> `* `.read SQL/sqlite3.sql`
* *`sqlite> `* `.quit`
10. Populate the songs database
* Run `python manage.py shell`
* ~~*`>>> `* `exec(open('./SQL/populate_songs.py').read())`~~ DOESN'T WORK YET!
* Instead, copy everything from `populate_songs.py` and then paste into the shell
* *`>>> `* `run()`
* This works for now...
11. Run the web server
* `python manage.py runserver`
12. (Optional) Create admin account to access the admin interface
* `python manage.py createsuperuser`
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment