Slash

Table of Contents

• Frameworks and Tools
• Installation
• Roadmap

Frameworks and Tools

• Django: API server and website backend.
• React: UI and website frontend.
• ProstgreSQL: Database.

(Top)

Installation

1. Clone the repository:

   git clone https://github.com/anyazhai/Slash.git

Running the Backend

2. Create a virtual environment for installation of required modules:

   cd backend
   python -m venv venv
   venv\scripts\activate
   pip install -r requirements.txt

3. Run the backend on the development server:

   python manage.py runserver

Now the backend is running. To access the admin panel go to http://localhost:8000/admin.

Running the Frontend

4. Open a new terminal window. Install frontend dependencies:

   cd frontend
   npm install

5. Run the frontend:

   npm start

The website is now up and running and can be accesed at http://localhost:3000 (if nothing else is mentioned).

(Top)

Roadmap

There are subsequent upgrades to be made to the project to reach the final stage. Here are a list of all immediate objectives:

• Configure Database.
• Develop authentication and authorization scheme.
• Develop project boards.
• Develop customisation options.
• Improve UI and UX.