Carbon Forming Competition Platform

A platform to support the evolution of distributed DIY carbon removal technology though monthly competition and collaboration.
· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

A platform to support the evolution of distributed DIY carbon removal technology though monthly competition and collaboration.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Node & NVM

Our current version of Vite requires a Node version of v18.6.0.

Node Version Manager (nvm) is reccomended for managing your local node installations. A .nvmrc file is located at the root of the project.

Discord

We use the Discord OAuth2 authoriation system to authenticate OpenAir server users and access API data on their behalf.

For local development, you will want to create a new test Application within the Discord Developer Portal. A Discord account is required.

Firebase

The application has been designed to be deployed to the Firebase app development platform. The Firebase services that are currently used are:

• Cloud Firestore
• Authentication for Web
• Cloud Storage for Web

For local development, you will want to create a new Project within the Firebase Console. A Google account is required.

Java

Firebase emulators require Java JDK version 11 or higher.

Installation

1. Clone the repo

   git clone https://github.com/openair-collective/Carbon-Forming.git

2. Install NPM packages in root and /functions directory

   npm install

   cd functions
   npm install

3. Copy and update your Environment Variable files (Read Docs)

   cp .sample.env .env.local
   cp ./functions/.sample.env.local ./functions/.env.local

   For developing on the actual web interface, ask contributors or maintainers of this repo for specific ENV values, which may need to be generated.

(back to top)

Usage

Running the Development Server

You will want to run these two commands in separate terminal instances

1. Run the Vite project in development mode

    npm run watch:dev

2. Run the Firebase emulators

    npx firebase emulators:start

3. The web interface will be accessible at http://localhost:5000.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

TBD

(back to top)

Contact

TBD

(back to top)