A service for game developers to use to help build games quickly.
First, set your app's secret key as an environment variable. For example, example add the following to .bashrc
or .bash_profile
.
export RANK_SECRET='something-really-secret'
Then run the following commands to bootstrap your environment.
git clone https://github.com/rdbaker/rank
cd rank
pip install -r requirements/dev.txt
npm install
python manage.py server
You will see a pretty welcome screen.
Once you have installed your DBMS, run the following to create your app's database tables and perform the initial migration:
createuser localuser
python manage.py db init
python manage.py db migrate
python manage.py db upgrade
python manage.py server
If you want to see your database with some initial admins, create a .admin.yml file with the contents:
-
username: <my username>
password: <my password>
-
username: <another username>
password: <another password>
Then run the command:
python manage.py seed_database
In your production environment, make sure the RANK_ENV
environment variable is set to "prod"
.
To open the interactive shell, run :
python manage.py shell
By default, you will have access to app
, db
, and the User
model.
To run all tests, run :
python manage.py test
Whenever a database migration needs to be made. Run the following commands: :
python manage.py db migrate
This will generate a new migration script. Then run: :
python manage.py db upgrade
To apply the migration.
For a full migration command reference, run python manage.py db --help
.
To build the docs:
move to the slate directory: :
cd slate/
then build the docs with middleman: :
bundle exec middleman build
you may first need to install slate's dependencies: :
cd slate/ && bundle install