Skip to content

Latest commit

 

History

History
executable file
·
113 lines (72 loc) · 4.67 KB

README.md

File metadata and controls

executable file
·
113 lines (72 loc) · 4.67 KB
Raw

Scratch & Map

Oh, the places you've gone! And the adventures that are still ahead of you! Travel can make the world feel smaller, but also more grand and beautiful—which is exactly how this interactive art presents it.

Prerequisites

You will need to install Python and pip.

If you are running a version of Python older than 3.4, you will also need to install virtualenv

.env files are not included in the repository. Please contact a dev team member for access.

Installing

  1. For Python 3.4 or newer: Run python3 -m venv venv.

For versions of Python older than 3.4, see above for virtualenv installation.

Continuing for all versions:

  1. Run virtualenv venv

  2. Mac - Run source venv/bin/activate Windows - Run venv\Scripts\activate

  3. Run pip install -r requirements.txt

  4. Set up environment variables for backend in the .env file.

DATABASE_URL= postgres://abcd1234ABCD:abcd1234ABCD1234@ec2-54-113-211-12.compute-1.amazonaws.com:5432/db7nordid9sd8
STRIPE_PUBLIC_KEY=pk_test_abcd1234ABCD1234
STRIPE_SECRET_KEY= sk_test_abcd1234ABCD1234

  1. Change directory to front end cd scratch-and-map-front-end

  2. Build dependencies with yarn install

  3. Set up environment variables for backend in the .env file in ~/scratch-and-map-front-end/.env

REACT_APP_BACKEND_URL=localhost:5000
REACT_APP_FB_APP_ID=123412341234

Getting Started

Start backend server with command: python server.py in root directory of project.

Start frontend server with command: yarn start in root of frontend folder.

Running the tests

From the root folder, within the virtual environment, run:

pytest  -v  --setup-show tests

Netlify predeployment tests run with each PR.

Break down into end to end tests

conftest.py - creates new instances of data for use in test cases within test_models.py

test_models.py - tests for correct table schema

And coding style tests

Tested predeployment via Netlify for header rules, pages changed, mixed content, and redirect rules.

Team utilized Prettier.

Deployment

Deployed via Heroku and Netlify. www.scratchandmap.club

Built With

Python Flask React Semantic UI React

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use date of release for versioning (YY.MM). Current version Version 19.05.

Authors


Abi Franklin
Brandon Moll
Courtney Buratto

Javier Alvarez
Pascale Pierre
Ryan Matthews

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

@gakko1 - Thank you for being at our beck and call. F.J. - Thank you for your guidance and cheerleading.