Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.83 KB

README.md

File metadata and controls

70 lines (45 loc) · 2.83 KB

Timber Computer

About

Timber Computer is an open-source project that helps understand the potential carbon impact of a future design by configuring a reference building.

The project was made possible by the Prototype Fund and was funded through the Federal Ministry of Education and Research from October 2021 until February 2022. Read more on the Prototype Fund's Demo Week 10 Website (in German).

If you are interested in supporting the project or simply want to find out more, please reach out via mail(at)timber.computer. We're looking forward to hearing from you!

Set-up

Backend

The backend runs on Strapi

Frontend

The frontend is powered by Astro, Vue 3, Nano Stores, Tailwind CSS, Vite

Usage

First install the dependencies:

npm install

Then move into frontend or backend folder.

In the frontend you can:

Command Description
npm run dev Runs dev server on http://localhost:3000
npm run start Runs dev server on http://localhost:3000
npm run build Runs Astro build process into dist folder
npm run preview Runs preview of build

In the backend you can:

Command Description
npm run develop Enable access backend in development
npm run start
npm run build Create files for backend
npm run strapi

This project runs on the current Node LTS version 16.x and uses npm workspaces.

To install global dependencies, that will be used for all workspaces, run npm install dependency-123 --save.

To install a dependency for the frontend, run npm install sass -workspace frontend --save-dev

Make sure you use the correct node.js version:

# with bash nvm
nvm use `cat .nvmrc`
# with windows nvm
nvm use $(cat .nvmrc)
# or just install the version specified inside `.nvmrc`

License

Unless otherwise described, the code in this repository is licensed under GNU AGPLv3. Please note that some modules, extensions, fonts or code herein might be licensed otherwise. If you have any questions, don't hesitate to get in touch via email.