Repository Organization
Our application source code is found under the src/ directory, where the file structure then follows django's defaults.
Any documentation needed for the project including diagrams, requirements, and the project plan is found inside the docs/ directory.
This README file is found in the top level directory.
Application Schemes
Filenames will be limited to one word and either use camel case or dashes in between words.
Git will be used for version control, with our remote repository on Github located on Ian's Github.
See "Git Workflow" for more information on how we will use git for our project.
Our project will follow the standard workflow outlined by Git.
The official documentation for the procedures can by found on Atlassian's Website.
This project will use the git feature branch workflow.
Instead of having a fork of the main repository, only use the single remote Github repository and pushing to that.
Any time you are working on a new feature make a new branch.
Before you push your code to Github first git pull to make sure that you are not pushing without having your local repository up to date.
This will make it easier for us to resolve merge conflicts by making sure that there are not any conflicts before you push your code.
Once you push your branch to remote, make a pull request so we can check and make sure everything is working before merging the branch to master.
As far as branch naming conventions go we should stick to lower case with dashes separating words.
Try and make branch names as descriptive as you can.
We also don't need to specify who made the branch in the branch name because git shows who makes which commits.
(Click on the links to visit their corresponding websites)
After considering Amazon Beanstalk, it became apparant that it might not be the best method of deployment for our applicaiton. We are currently considering Heroku, another platform dedicating to hosting apps in many languages, including python and specifically Django.
This is a simple web application so use any text editor you want.
This project will be written in Python and JavaScript, along with some HTML and CSS.
We can use Reactjs to embed the majority of the HTML in the js files.
For CSS we can make a custom style sheet, or we can do custom css embedded in our js files with React.
We will also use a CSS framework called Bootstrap.
This project is built using the django framework.
To run the webpage on a local server navigate to src/ and run:
$ python manage.py runserver
There are some dependencies associated with the application that may need downloaded.
See the "Dependencies/Libraries" section in this readme file.
Once the local server is up and running, open up a browser and pull up your localhost on port 8000:
http://localhost:8000/
This will take you straight to the homepage of our application, where you can then navigate across the site using the navigation.
To speed up and aid the development process, our application uses several useful libraries.
These python libraries include:
All of these packages can be downloaded using python's package manager, pip.
Unit testing instructions will appear here once we are far enough into the project.
System testing instructions will appear here once we are far enough into the project.
Phase 2:
- High fidelity prototype files are located in the src/template folder, which includes a home, inventory, and tool checkout page.
- Low fidelity wireframe is found in the docs/diagrams folder.
- Screenshots that include our Github issues page and srum bored are located in the docs/phase2screenshots folder.
Phase 3:
- The documents required for this milestone's deliverables are loacted in /docs/Phase 3 Documents.
- This includes all sprint planning documents, standup reports, and updated documents such as the project plan and requirements.
- Screenshots that include our current issues page and scrum board are in teh docs/phase3screenshots folder.
set up virtual environment for the django project to make running on beanstock easier or manage requirements.txt manually
set up tool stack so that everything is ready for development to actuallys start