Project Setup

CodeForBC-Web

Website of CodeForBC

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Recommended VS Code Extensions
• Development
  • Running Locally

Getting Started

To set up the project locally on your system, please follow the steps below:

Prerequisites

Before proceeding with the installation, make sure you have the following prerequisites:

• Node.js (LTS version 20)
• VS Code
• SSH Key Setup: Ensure that you have set up your SSH key for authentication. If you haven't done this yet, follow the GitHub guide on generating and adding SSH keys before starting the project installation.

Installation

1. Clone the repository:

   git clone [email protected]:OpenBCca/openbc-web.git

2. Navigate to the project directory:

   cd openbc-web

3. Install dependencies(can skip if you want to use docker instead):

   npm install

Recommended VS Code Extensions

For an optimal development experience, consider installing the following VS Code extensions. They are recommended for this workspace:

• Prettier - Code formatter
• ESLint
• Flutter Color
• Code Spell Checker

Install these extensions either through the VS Code Extensions sidebar or by running the following commands in the terminal:

code --install-extension esbenp.prettier-vscode

code --install-extension dbaeumer.vscode-eslint

code --install-extension circlecodesolution.ccs-flutter-color

code --install-extension streetsidesoftware.code-spell-checker

Development

Running Locally

To run the project locally, follow these steps:

1. In the VS Code terminal, start the development server using the following command:

   npm start

   or

   docker-compose up

   If you wish to use docker

2. Open your web browser and navigate to http://localhost:3000.

The project is now running locally, and you can view it in your browser. Keep the terminal open to maintain the project's active state.