Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 3.78 KB

README.md

File metadata and controls

85 lines (57 loc) · 3.78 KB
Raw

Build Status Codacy Badge Codacy Badge Code Climate Issue Count Gitter

BucketList

The innovative bucketlist app is an application that allows users to record and share things they want to achieve or experience before reaching a certain age meeting the needs of keeping track of their dreams and goals.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

  • Just clone this repository by typing: git clone https://github.com/Lemmah/BucketList.git
  • Switch to project directory: cd BucketList
  • Install project requirements using python pip. But wait, you have to have some stuff before you get to this point. So these are:

Prerequisites

  • Python3.5 and above
  • Python virtual environment Just type:
python -V

in your terminal and if its not greater than or equal to 3.5, you're not in big trouble, there are tons of tutorials to get up up and running with these. Just grub one then come back when done.

Installing

Now, you have python3 and a way of running a virtual environment. Lets set up the project environment.(remember we're still in the app directory)

  1. Create your virtual environment. Usually, without any wrappers:
python -m venv my_venv
  1. Start your virtual environment:
source my_venv/bin/activate
  1. Install the project requirements specified in the requirements.txt file. Usually,
pip install -r requirements.txt

This is enough to get you started. You can now run the application using: gunicorn runapp:app --log-file - or python runapp.py

Running the tests

Easy, just: pytest app/

Deployment

This app is ready for Heroku. You can deploy your copy of this app by: heroku create <your_url_name> (where <your_url_name> is what you want to call your app) git push heroku master ..and boom, you're done! You can chat me on gitter in case of any problems.(gitter link is on badge above) If you have never worked with Heroku, you can learn how to Deploy Python Applications on Heroku

Built With

Contributing

Contributing to this project is closed for the first month. Thereafter, you can make your pull request. Three more days before you can make your pull request. :D

Versioning

For the versions available, see the tags on this repository.

Authors

  • James Lemayian - Kickstarting the project - @Lemmah

License

This project is currently under the Creative Commons attribution.

Acknowledgments

  • Andela Kenya - Inspiring the idea.