Code Monkey home page Code Monkey logo

climateconnect's Introduction

Climate Connect

Pre-steps

  1. Create a local postgres database with your own username and password. You will connect to this for your local backend project.
  2. Create 32 char random secret key for your local setup. Run openssl rand -base64 32. Copy the value you will be using this to add as SECRET_KEY for django settings.

Getting Started Locally

We are using Python/Django for backend and Next.js for frontend.

  1. Create a python virtual environment python3 -m venv climateconnect_env
  2. Run following commands to start virtual environment
       cd climateconnect_env
       source bin/activate
    
  3. Clone github repository git clone <URL>

Backend

Once you clone the repository start backend server.

  1. Go to backend directory cd backend
  2. Run pip install -r requirements.txt to install all backend libararies.
  3. Create .backend_env to include backend environment variables. Note: Connect with other collaborators to get env variables
  4. Run python manage.py migrate to run django migrations. Note: This command is used for when you first start or whenever you are adding or updating database models.
  5. Run server using python manage.py runserver.
  6. If you want to run tests suite use this command: python manage.py test. If you want to run a specific test file or test class run this command: python manage.py test <file_path> or <file_path + class_name>

Frontend

  1. cd frontend
  2. Run yarn install to download all npm packages
  3. Add .env file for frontend environment variables.
  4. Run yarn dev to start developing

To Deploy

  1. Run yarn build to build our the website
  2. ??? Rest of deploy procedure is work in progress. Backend deploy coming soon!

climateconnect's People

Contributors

positiveimpact avatar evanhahn avatar ddhanesha avatar reecelangerock avatar susanchesnut avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.