timewebsite

Alpha website, NE Wisc creatives / TIME community (tech, innovators, makers, entrepreneurs)

 ___________________________________________________________
/ It's T.I.M.E!                                             \
|                                                           |
| N.E. Wisconsin's Community of...                          |
|                                                           |
\ [T]echnologists, [I]nnovators, [M]akers, [E]ntrepreneurs! /
 -----------------------------------------------------------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

See the wiki for more details of the intent of this project.

This community web site project encourages participation and contribution no matter your experience level with web development. If you have a question, need some help, or want to participate some other way, open an issue and ask away! If you know you way around web development, look for something that needs fixing, fix it and open a pull request!

As a learning-friendly endeavor, the project is based on the learnings acquired from following this excellent tutorial series of Youtube videos: https://github.com/realpython/discover-flask

Prerequisites:

On Linux, *BSD, Mac OS X, and Windows:

1. Install Docker Engine
2. (If Linux or *BSD) Install Docker Compose
3. Install git
4. (Optional) Install Atom editor + linter-flake8 Atom package

Setup the project on your computer

Fork the repository

1. Create an account on Github and add your SSH keys. These are used to authenticate your git commands with Github. Github has nice documentation on this step.
2. Log in to Github
3. Visit https://github.com/dhmncivichacks/timewebsite
4. Click the word "Fork" in the upper right of this page. This makes a copy of the source code under your user account with Github.

From your command prompt:

1. "Make a directory" for storing your source code:

mkdir src

1. "Change directory" into your source code directory:

cd src

1. Download your forked copy to your source code directory:

git clone [email protected]:<YOUR GITHUB USERNAME>/timewebsite.git

1. "Change directory" into the project:

cd timewebsite

1. Run the handy reset.sh script

./reset.sh

Now you should be able to view the application in your browser using the URL printed at the end of the script run.

Try logging in with username admin password admin

Unit tests and test coverage

• Run the tests

  docker-compose exec web python manage.py test

• Run the test coverage report (generates HTML files into coverage/ directory)

  docker-compose exec web coverage run -m unittest discover tests docker-compose exec web coverage html -d coverage

• Run the linter(style-checker)

  docker-compose exec web flake8 --ignore=E402