Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 4.38 KB

README.md

File metadata and controls

75 lines (51 loc) · 4.38 KB

KzBLOGS

SRMKZILLA Logo

A blogging platform that allows users to create, edit, and manage blogs with authentication, search functionality, and a user-friendly interface.

crafted with by your friends on the SRMKZILLA team.

version 0.1.0 license MIT author SRMKZILLA

Structure

KZBLOGS is a monorepo containing the backend server built with FastAPI and the frontend under the client folder.

Installation 🔧

Install dependencies:

$ pip install -r requirements.txt

Set up the database:

$ alembic upgrade head

Run the server:

$ uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload

Stack

FastAPI Python PostgreSQL Docker React TypeScript TailwindCSS

Shout outs 💥

Alvin Ben George
Alvin Ben George

Rushi Patel
Rushi Patel

Saanvi Kumar
Saanvi Kumar

Manaya Pachpor
Manaya Pachpor

Shivam Bansal
Shivam Bansal

License 📜

KZBLOGS is available under the MIT license. See the LICENSE file for more info.

Contributing 🤝

Please read Contributing.md for details on our code of conduct and the process for submitting pull requests.

Forking this repo 🚨

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.

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.

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 if you're not sure what to do. Thanks!