/frienden

Primary LanguagePython

Frienden

Heroku Host

🚀 Getting Started

Installation and Requirements

Requirements:

python3
Django
djangorestframework

Installation:

# clone the repository
git clone https://github.com/Jeromeschmidt/frienden
# cd into the project
cd frienden
# create a virtual environment and install the required packages
pipenv shell
pipenv install

Congrats you should now have a working install of Make Resources

Running The Project Locally

If you have not yet followed the installation steps, go and do so before continuing.

Once you have everything installed, you need to create.env and populate the fields with real data.

# cd into the src folder
cd frienden
# populate the .env file with correct data
vim .env

Once you have created the .env file and populate it with correct data, all you need to do is run the server!

# run the the server
python3 manage.py runserver
# navigate to the url to see your running application!
http://localhost:8000

🤓 Specs

Proposal

Proposal

Requirements

  • At least 2 apps in project
  • At least 2 tests in tests.py in each app
  • Modular design
  • RESTful API using Django Rest Framework
  • Template-based front-end interface
  • Has purpose and fulfills purpose
  • Integrates an open source app
  • Deployed and usable
  • Includes database migrations in each app
  • README with documentation
  • Public Github Repo
  • No exposed secrets

Built With

Credit: https://github.com/tempor1s for the README format