bujair111 / README-file-for-all-repo

Customisable readme file for all repository

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Logo

Title

Short Discription of the Project
Explore the docs »
View Site · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Running this project
  3. Screenshots
  4. Contact

About The Project



Lorem ipsum dolor sit amet, consectetur adipiscing elit. In sit amet cursus ex. Maecenas id lacus ut diam placerat lobortis ac quis nisl. Nulla mattis, sapien quis ultricies bibendum, quam erat gravida velit, eget auctor metus est et leo. Nam tristique vulputate ante at malesuada. Nulla egestas semper ante, et imperdiet elit posuere ut. Integer id nibh eu massa scelerisque aliquet vel vel lacus. Duis luctus dictum odio id dapibus. Suspendisse eu erat odio.. You can find the deployed project here.

  • Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  • In sit amet cursus ex.
  • Maecenas id lacus ut diam placerat lobortis ac quis nisl.
  • Nam tristique vulputate ante at malesuada.
  • imperdiet elit posuere ut.

Built With

Python JavaScript HTML5 CSS3

Django DjangoREST React Redux SASS Tailwind CSS Bootstrap AntDesign Chakra UI

PostgreSQL MongoDB SQLite Firebase MySQL RabbitMQ

Github Pages AWS Nelify Railway

Git GitHub Figma Canva Visual Studio Code macOS

Twilio .NET Angular Chart Js Docker Express Js FastAPI Flask JQuery Jupyter JWT Kubernetes Node Js Next Js


Running this project

This is a sample for Django Project. To get this project up and running you should start by having Python installed on your computer. It's advised you create a virtual environment to store your projects dependencies separately. You can install virtualenv with

pip install virtualenv

Clone or download this repository and open it in your editor of choice. In a terminal (mac/linux) or windows terminal, run the following command in the base directory of this project

virtualenv venv

That will create a new folder env in your project directory. Next activate it with this command on mac/linux:

source venv/bin/active

Then install the project dependencies with

pip install -r requirements.txt

Apply migrations and create your database

python manage.py migrate

Create a user with manage.py

python manage.py createsuperuser

Now you can run the project with this command

python manage.py runserver

Screenshots

Light Mode

Dark Mode


Contact

About

Customisable readme file for all repository