Skip to content

zuri-training/clovar_cms

Repository files navigation



contributors python-versions pypi contributors

Clovar is a Content Management System that allows users to spin up a basic website and allows as many customizations as possible.

Site Preview

Contributing

See CONTRIBUTING.md if you want to make contributions to this project.

Please ensure you follow the steps in the CONTRIBUTING.md. If you don't, your contribution will be rejected.

Run Locally

Preferred tool for creating and managing virtual environments: pipenv (see installation guide: https://pypi.org/project/pipenv/).

Clone the project

git clone https://github.com/zuri-training/team-15_my-cms.git

Go to the project directory

cd team-15_my-cms

Create a virtual environment and install needed dependencies in it

pipenv install

Activate the virtual environment

pipenv shell

Create a .env file in the same directory as the settings.py (config folder) with the following contents:

Don't enclose the secret key in any quotation mark.

SECRET_KEY=<your-secret-key>

Generate a secret key from https://djecrety.ir/.

Run the migrations

python manage.py migrate

Run the server

python manage.py runserver

Architecture Used: Monolith (Django Templating)

Features

  • User: Unauthenticated

    • Visit the platform to view basic information about it.
    • View and Interact with the documentation.
    • Register to set up a new website.
    • Setup the website by filling out some information.
    • Browse through available templates.
  • User: Authenticated

    • Full access to the platform.
    • Access to the backend of the created website.
    • Ability to create more pages.
    • Ability to change the template.
    • Unique address.
    • Ability to add social media links.

Tools Used

HTML • CSS • JavaScript • Python • Django • Figma

Useful Resources

Contributors

Developers
Product Designers