BangazonAPI

This is an API for Bangazon INC. This API will allow user to GET/POST/PUT and (sometimes) DELETE items from the Bangazon Database. Before you can utilize the database, there are a few things you need to make sure you have installed.

Installing Core Technologies

1. SQLite

For OSX Users

brew install sqlite

For Windows Users

Visit the SQLite downloads and download the 64-bit DLL (x64) for SQLite version, unzip and install it.

2. SQL Browser

The DB browser for SQLite will let you view, query and manage your databases for this project.

3. Visual Studio Code

Visual Studio Code is Microsoft's cross-platform editor that you can use to view Python and Django code.

Setting up environment and installing dependencies

1. Set up your virtual environment

Within the terminal, navigate to the location where you'd like to create the new environment and Bangazon project. Create a folder called BangazonProject and navigate within the new folder. Then, enter this text to create the new environment:

virtualenv ENV

Then activate your environment:

source ENV/bin/activate

Note that you can type "deactivate" to end the new environment at any time.

2. Install Django

Within your new BangazonProject folder, download the Django code by typing:

pip install django

3. Download the Bangazon project

Within your new BangazonProject project folder, download the source code by typing:

git clone https://github.com/blathering-barnacles/Bangazon.git

4. Starting the project server

After downloading the Banagzon project, you should have a new folder within the BangazonProject folder that you created. The new folder will also be called Bangazon. Navigate within this folder. Start the server by typing:

python manage.py runserver

5. Navigate to the Bangazon workforce webpage

Within your web browser, navigate to http://localhost:8000/workforce/ From here, you should see the main links for the Bangazon workforce application.

Creating the Bangazon DB

While inside the BangazonProject/Bangazon folder, enter this command:

python manage.py makemigrations Workforce

Then enter

python manage.py migrate

You now have a database named sqlite3.sql within your existing folder. Use the DB Browser for SQLite to open the new database if desired.

Entity Relationship Diagram

Unit Testing

Navigate within the BangazonProject/Bangazon project and enter this command:

python manage.py test

This will run all of the Unit Testing files created within the BangazonProject/Bangazon/bangazon_1/workforce/tests folder.

Bangazon was created by the Blathering Barnacles - Cohort 28:

John Wood

Daniel Combs

Robby Hecht

Andrew Herring