Skip to content

Porogoramer/porogoramer.com

Repository files navigation

porogoramer.com

A comprehensive guide to understanding and using the porogoramer.com repository.

Static Badge Static Badge

About the project

Porogoramer.com is the hub for our Minecraft server hosting services and the portfolio showcase for our community members.

Built with

Frontend

  • React
  • SASS
  • Babel
  • TypeScript

Backend

  • NodeJS
  • Python
  • Django
  • DjangoREST

Package Management

  • NPM

Testing

  • Jest
  • DjangoTest

Getting Started

  1. Run the following command in the repo root terminal:
python -m venv .venv

This command creates a virtual environment named .venv in your project directory.

  1. Activate the virtual environment by running the following command:
. .venv/Scripts/activate

This command activates the virtual environment and ensures that the Python dependencies are installed in the virtual environment instead of the global Python environment.

  1. Install the required Python dependencies by running the following command:
pip install -r requirements.txt
  1. Navigate to the folder where package.json is located and install the required JavaScript dependencies by running the following command:
npm install
  1. Once the dependencies are installed, you can start working on your Django React project.

How to Run the project

Before running the project, ensure you have completed the setup steps mentioned above.

  1. Apply Migrations:
python manage.py migrate

This command applies any pending migrations to your database.

  1. Run the Django Server:
python manage.py runserver

This starts the Django development server. The output will give a url you can open.

  1. Run the Frontend Development Server: Open a new terminal and navigate to the frontend directory of the repo where package.json is located.
npm run dev

This command starts the frontend development server.

Important note

We perform linting to maintain consistency and code quality. Please install these three VS Code extensions to follow our linting rules.

Support

We’re always looking to improve. If you have suggestions for new features, enhancements, or bug related issues, we'd love to hear from you. Let us know !