c4patino/csmb-housewars
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added .env section to README

Browse source
This commit is contained in:
Ceferino Patino 2022-05-26 18:44:05 -05:00
commit 6610a5ff28
2 changed files with 10 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -6,6 +6,7 @@ Welcome to the repository for the Collegiate School of Medicine and Bioscience H
| ------- |
| [Usage](#Usage-Instructions) |
| [Installation](#Installation) |
| [Defining .env](#Defining-env) |
| [Contributing](#Contributing) |
## Usage Instructions
@ -31,11 +32,19 @@ Welcome to the installation section of the guide. This will walk you through ins
5. Run migrations and create a development sqlite3 database using `python manage.py migrate`.
6. Server should be available to run. You can activate the server using `python manage.py runserver`. The site will be accessible using the [default url](http://localhost:8000).
## Defining .env
The `.env` file is used to secure data and keep it from entering a cloud, open-acccess environment. Because of this, you will need to define a `.env` file yourself. The parameters that you will need are:
- SECRET_KEY - This will contain the server key of your django local server. It can be generated using the command `python -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'`.
- DATABASE_USERNAME - This will be the username of your production database.
- DATABASE_PASSWORD - This will be the password of your production database.
- DATABASE_HOST - This will be IPv4/IPv6 address of your production database.
- DATABASE_NAME - This will be the name of your production database.
## Contributing
As an open-source school repository we welcome all contributors willing to help make our website better.
### Instructions
1. Follow the [Installation instructions above](#Installation-Instructions) to install the required packages and run the local server. You will want to fork the repository before cloning it.
1. Follow the [installation instructions above](#Installation) to install the required packages and run the local server. You will want to fork the repository before cloning it.
2. Commit your new features to your new forked repository.
3. Create a pull request that details the changes/improvements that you have made.
4. Wait for @C4theBomb to open discussion/merge your pull request.

2
housewars/tests.py
View file

@ -1,3 +1 @@
from django.test import TestCase
# Create your tests here.