Skip to content

Latest commit

 

History

History
119 lines (86 loc) · 3.26 KB

how-to-contribute.md

File metadata and controls

119 lines (86 loc) · 3.26 KB
Raw

How To Contribute

Requirements

Node.js

Java (OpenJDK)

  • Java is required for certain build processes. Follow the instructions below to install OpenJDK on your system.

    [!TIP] Some members have successfully installed Java using this process: Installing Java

Environment Setup

  • Copy the contents of .env.example to .env.
  • Environment variables such as Discord and GitHub tokens will be granted only for frequent contributors. The application can work without these variables set, but capabilities will be limited.

Getting Started

  1. Fork the repository by clicking the "Fork" button on the GitHub page.

  2. Clone your forked repository:

    git clone https://github.com/<your-github-username>/web3-bootcamp-platform.git
cd web3-bootcamp-platform

  3. Install dependencies:

    yarn install

  4. Start the Firebase emulator:

    yarn emulator

  5. Seed data to the local database, open a new terminal and run:

    yarn seed

  6. Run the development server:

    yarn dev

Open http://localhost:3000 with your favorite browser to see your project.

Deploy to production

You can see the results locally in production mode with:

$ yarn build
$ yarn start

The generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS from Tailwind CSS.

Now, the plataform is ready to be deployed. All generated files are located at build folder, which you can deploy with any hosting service.

Deploy to Vercel

Deploy this project on Vercel in one click:

Deploy with Vercel

Installing Java

Mac

  1. Install OpenJDK using Homebrew: 
    brew install --cask temurin
  2. Add the following lines to your shell configuration file (~/.zshrc, ~/.bashrc, etc.) to set the JAVA_HOME and update the PATH: 
    export JAVA_HOME=$(/usr/libexec/java_home)
export PATH=$JAVA_HOME/bin:$PATH
  3. Reload your shell configuration: 
    source ~/.zshrc  # or source ~/.bashrc

Windows

  1. Download and install Java from the official Oracle website. Make sure to choose the version suitable for your system.
  2. Open Command Prompt and set the JAVA_HOME environment variable: 
    set JAVA_HOME=C:\Program Files\Java\jdk-22
  3. Add Java to your PATH: 
    set PATH=%JAVA_HOME%\bin;%PATH%
  4. Restart Visual Studio Code or your development environment.

Linux

  1. Install OpenJDK using your package manager: 
    sudo apt install openjdk-22-jdk
  2. Add the following lines to your shell configuration file (~/.bashrc, ~/.zshrc, etc.) to set the JAVA_HOME and update the PATH: 
    export JAVA_HOME=/usr/lib/jvm/java-19-openjdk-amd64
export PATH=$JAVA_HOME/bin:$PATH
  3. Reload your shell configuration: 
    source ~/.bashrc  # or source ~/.zshrc