https://github.com/imthaghost/mediumflask
Medium clone built with flask
https://github.com/imthaghost/mediumflask
Last synced: 6 months ago
JSON representation
Medium clone built with flask
- Host: GitHub
- URL: https://github.com/imthaghost/mediumflask
- Owner: imthaghost
- Created: 2020-01-11T21:43:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-20T02:43:28.000Z (over 5 years ago)
- Last Synced: 2025-08-18T19:55:04.169Z (11 months ago)
- Language: HTML
- Size: 2.58 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Welcome to mediumFlask
> A medium clone with a flask backend
### 💻 Prerequisites
What things you need to run the software
```bash
- Python 3.4+
- Pipenv
- Mongo
```
## 🚀 Getting Started - Local
### macOS Mojave 10.0+, Catalina 10.1+
```bash
# 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
```
## :hammer: Built With
- [Flask](https://www.djangoproject.com/) - Web Framework
- [MongoDB](https://www.mongodb.com/) - Database
- [NodePress](https://nodepress.com.ng/) - Front End
## 🤝 Contribution Guidlines
### Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (use [Github Flow](https://guides.github.com/introduction/flow/index.html)).
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](http://choosealicense.com/licenses/mit/) 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
