|
1 | | -# kzblogs |
| 1 | +# KzBLOGS |
2 | 2 |
|
3 | | -kzilla official blogging website |
| 3 | +<div align="center"> |
| 4 | + <img alt="SRMKZILLA Logo" src="client/public/srmkzilla-gradient-logo.svg" height="56" /> |
| 5 | +</div> |
| 6 | +<p align="center"> |
| 7 | +A blogging platform that allows users to create, edit, and manage blogs with authentication, search functionality, and a user-friendly interface. |
| 8 | +</p> |
| 9 | +<p align="center"> |
| 10 | +crafted with <span style="color: #8b0000;">♥</span> by your friends on the <a href="https://srmkzilla.net">SRMKZILLA</a> team. |
| 11 | +</p> |
| 12 | +<p align="center"> |
| 13 | + <img src="https://img.shields.io/badge/version-0.1.0-orange" alt="version 0.1.0"/> |
| 14 | + <img src="https://img.shields.io/badge/license-MIT-brightgreen" alt="license MIT"/> |
| 15 | + <img src="https://img.shields.io/badge/author-SRMKZILLA-orange" alt="author SRMKZILLA"/> |
| 16 | +</p> |
| 17 | + |
| 18 | +## Structure |
| 19 | + |
| 20 | +`KZBLOGS` is a monorepo containing the backend server built with FastAPI and the frontend under the `client` folder. |
| 21 | + |
| 22 | +## Installation 🔧 |
| 23 | + |
| 24 | +Install dependencies: |
| 25 | + |
| 26 | +``` |
| 27 | +$ pip install -r requirements.txt |
| 28 | +``` |
| 29 | + |
| 30 | +Set up the database: |
| 31 | +``` |
| 32 | +$ alembic upgrade head |
| 33 | +``` |
| 34 | + |
| 35 | +Run the server: |
| 36 | +``` |
| 37 | +$ uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload |
| 38 | +``` |
| 39 | + |
| 40 | +## Stack |
| 41 | + |
| 42 | + |
| 43 | + |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | +## License 📜 |
| 51 | + |
| 52 | +`KZBLOGS` is available under the MIT license. See the LICENSE file for more info. |
| 53 | + |
| 54 | +## Contributing 🤝 |
| 55 | + |
| 56 | +Please read `Contributing.md` for details on our code of conduct and the process for submitting pull requests. |
| 57 | + |
| 58 | +## Forking this repo 🚨 |
| 59 | + |
| 60 | +Many people have contacted us asking if they can use this code for their own projects. The answer to that question is usually "yes," with attribution. There are some cases, such as using this code for a business or something that is greater than a personal project, that we may be less comfortable saying yes to. If in doubt, please don't hesitate to ask us. |
| 61 | + |
| 62 | +We value keeping this site open-source, but as you all know, _**plagiarism is bad**_. We spent a non-negligible amount of effort developing, designing, and trying to perfect this iteration of our project, and we are proud of it! All we ask is to not claim this effort as your own. |
| 63 | + |
| 64 | +So, feel free to fork this repo. If you do, please just give us proper credit by linking back to our website, https://srmkzilla.net. Refer to this handy [quora post](https://www.quora.com/Is-it-bad-to-copy-other-peoples-code) if you're not sure what to do. Thanks! |
4 | 65 |
|
5 | | -## Environments and setup |
|
0 commit comments