Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 3 KB

README.md

File metadata and controls

103 lines (72 loc) · 3 KB
Raw

OtakuStan CMS

Welcome to OtakuStan CMS Repository

About

This is an Central Content Management system for Otakustan to power all our dynamic content like blogs, articles, news feed, guest feed, etc for our website and podcasts. This made for OtakuStan's internal use only. The main user website is made using Django and Django rest framework.

🏗️ Built With

Features

  • Create Blogs
  • Create Articles
  • Create News Feed
  • Create Guest Feed
  • One Api for all our websites
  • Manage Content
  • Live Update

Install and Run

Make sure you have Python 3.x installed and the latest version of pip installed before running these steps.

  1. Clone the repository using the following command
git clone [email protected]:OtakuStanYoutube/cms.git
# After cloning, move into the directory having the project files using the change directory command
cd cms
  1. Create a virtual environment where all the required python packages will be installed
# Use this on Windows
python -m venv env
# Use this on Linux and Mac
python -m venv env
  1. Activate the virtual environment
# Windows
.\env\Scripts\activate
# Linux and Mac
source env/bin/activate
  1. Install all the project Requirements
pip install -r requirements.txt

-Apply migrations and create your superuser (follow the prompts)

# apply migrations and create your database
python manage.py migrate

# Create a user with manage.py
python manage.py createsuperuser
  1. Run the development server
# run django development server
python manage.py runserver

🔐 License

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

Suggestions and Bug Reports

Since this is an open source project all suggestions, requests and bug reports are always welcomed. If you have any don't forget to leave them in the issues section. But we recommend creating an issue or replying in a comment to let us know what you are working on first that way we don't overwrite each other.

Don't forget to checkout the CONTRIBUTING.md for more info on how to contribute to this project.

Branches

  • staging -> pr this branch for everything
  • prod -> don't even think of touching it, this is what's running in prod

Credits

This was built by the following individuals.