-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
83 changed files
with
119,719 additions
and
43,463 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,6 +3,15 @@ | |
| This is the main CityCatalyst Web app. This directory includes both the | ||
| frontend and backend code for the app, as well as database management scripts. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| This guide assumes you have installed and access to the following tools: | ||
|
|
||
| 1. git command line interface. Please follow [this link](https://git-scm.com/downloads) for installation instructions. | ||
| 2. Node.js and the node package manager npm. Please follow [this link](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for installation instructions. | ||
| 3. (optional) docker engine. Docker is not strictly necessary but recommended. It makes the setup of the database service much easier. Please follow [this link](https://docs.docker.com/engine/install/) for installation instructions. | ||
| 4. (optional, Windows OS only) Windows Subsystem for Linux WSL2. This step is only needed for running the convenience shell scripts below e.g. for setting up the Postgres database via docker. Different Linux subsystems can be installed. The following link is for Ubuntu. Please follow [this link](https://ubuntu.com/desktop/wsl) for installation instructions. | ||
|
|
||
| ## Installation | ||
|
|
||
| ### Code | ||
|
|
@@ -22,7 +31,22 @@ npm install | |
|
|
||
| ### Database | ||
|
|
||
| For a quick setup, run `scripts/start-db.sh`, which will launch a PostgreSQL Docker image with the right configuration. Otherwise continue below ⬇️ | ||
| #### Automated setup via Docker | ||
|
|
||
| For a quick setup, run `scripts/start-db.sh`, which will launch a PostgreSQL Docker image with the right configuration. | ||
|
|
||
| Note for Windows users only: Make sure you run this script in the WSL2 environment. Since WSL2 does not share the same resources as the Windows host system, you have to configure the integration of docker with the WSL2 system. For this, open Docker Desktop, go to `Settings > Resources > WSL integration` and activate `Enable integration with my default WSL distro` and make sure your Linux distribution is listed and enabled. | ||
|
|
||
| Run the following command. | ||
|
|
||
| ```bash | ||
| cd app/scripts/ | ||
| bash start-db.sh | ||
| ``` | ||
|
|
||
| If you use this script, continue at [Environment](#environment). Otherwise continue below ⬇️ with the manual setup of the database service. | ||
|
|
||
| #### Manual setup | ||
|
|
||
| You'll need to run a [PostgreSQL](https://www.postgresql.org/) database, locally or remotely. | ||
|
|
||
|
|
@@ -82,7 +106,10 @@ To run the app in development mode, run: | |
|
|
||
| ```bash | ||
| cd CityCatalyst/app | ||
| cp env.example .env | ||
|
|
||
| ## if you have copied and renamed the env.example file in the step under 'Environment', | ||
| ## skip the next line otherwise remove the comment in the next line | ||
| #cp env.example .env | ||
|
|
||
| ## set up your database credentials in .env file | ||
|
|
||
|
|
@@ -96,6 +123,10 @@ npm run create-admin | |
| npm run dev | ||
| ``` | ||
|
|
||
| The standard port is 3000 and the application can be opend at http://localhost:3000. Please check the log outputs, if a different port has been used. | ||
|
|
||
| Use `[email protected]` and `password` to login. | ||
|
|
||
| ### Docker | ||
|
|
||
| You can also run the app in a Docker container. To do so, you'll need to build the Docker image: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,5 +20,5 @@ CHAT_PROVIDER=huggingface | |
| ADMIN_EMAILS="[email protected]" | ||
| ADMIN_NAMES="John doe" | ||
| NEXT_PUBLIC_OPENCLIMATE_API_URL="https://openclimate.openearth.dev" | ||
| DEFAULT_ADMIN_EMAIL=johndeo@example.com | ||
| DEFAULT_ADMIN_EMAIL=johndoe@example.com | ||
| DEFAULT_ADMIN_PASSWORD=password | ||
22 changes: 22 additions & 0 deletions
22
app/migrations/20240627123051-EmissionsFactor-add-columns.cjs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| 'use strict'; | ||
|
|
||
| const columns = ["actor_id", "methodology_name"]; | ||
|
|
||
| /** @type {import('sequelize-cli').Migration} */ | ||
| module.exports = { | ||
| async up(queryInterface, Sequelize) { | ||
| return queryInterface.sequelize.transaction(async (transaction) => { | ||
| for (const column of columns) { | ||
| await queryInterface.addColumn("EmissionsFactor", column, Sequelize.TEXT, { transaction }); | ||
| } | ||
| }); | ||
| }, | ||
|
|
||
| async down(queryInterface) { | ||
| return queryInterface.sequelize.transaction(async (transaction) => { | ||
| for (const column of columns) { | ||
| await queryInterface.removeColumn("EmissionsFactor", column, { transaction }); | ||
| } | ||
| }); | ||
| } | ||
| }; |
Oops, something went wrong.