Welcome to mediumFlask

A medium clone with a flask backend

💻 Prerequisites

What things you need to run the software

- Python 3.4+
- Pipenv
- Mongo

🚀 Getting Started - Local

macOS Mojave 10.0+, Catalina 10.1+

# clone the repo
git clone https://github.com/imthaghost/mediumFlask
# change into project directory
cd mediumFlask
# start virtual enviornment
pipenv shell
# install dependencies
pipenv install
# in another shell create mongodb instance
sudo mongod

🔨 Built With

• Flask - Web Framework
• MongoDB - Database
• NodePress - Front End

🤝 Contribution Guidlines

Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (use Github Flow).

1. Fork the repo and create your branch from master.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Use a Consistent Coding Style

• PEP 8 style unification
• 2 spaces for indentation rather than tabs (or tabs that convert to spaces)
• You can try running pipenv install autopep8 --dev for style unification

📝 License

By contributing, you agree that your contributions will be licensed under its MIT License.

Contributors

Gary Frederick 💻