Resilience Webs are interactive digital maps of most environmental and social justice related organisations working within and for a place.
Inspiration: https://www.transitioncambridge.org/thewiki/wiki-uploads/TTEvents.TranNews/megsweb.pdf
Currently online at https://resilienceweb.org.uk
Getting started
Prerequisites
Check these are installed:
- Node.js
- To select the right runtime check the
.nvmrc file, alternatively if you have node version manager (nvm) installed simply run the nvm install command
- Docker
Installation
- Clone a local copy of the repository
- Create a
.env file by copying the .env.example file:
cp .env.example .env
npm install
- Build and run a development version of the app:
npm run dev
It will open in your default browser at http://localhost:4000.
Local database setup
- Ensure you have a valid
.env file, the example DATABASE_URL environment variable will be used in this process
- Set
RW_TEST_USER_EMAIL in .env to your own email address. This will help the Prisma seed function create a test account for you. The email needs to be valid as authentication works via an OTP code sent to your email.
- To create the local database:
npm run db:up
- To prepare the database with tables:
npx prisma migrate reset
- To view the databases contents:
npm run db
Usage
See the knowledge base for more information.
Database seeds can be run with:
npx prisma db seed
Deploying
Contributing
If you'd like to contribute to the project, get in touch at [email protected]. We welcome anyone who wants to contribute code, documendation or testing efforts.
If you'd prefer to support the project financially, you can do so at https://opencollective.com/resilience-web.
Technical details
I wrote a blog post that goes through technical choices that I made for this project. You can read it here: https://dinerismail.dev/blog/how-i-built-a-product-that-people-love
License
The source code of this project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). If you run a modified version of this software as a network service, you must make your modified source code available to its users.
The content on Resilience Web sites (listings, descriptions and other directory data) is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).
Acknowledgements
Many thanks to Gitbook for supporting our project by giving us a membership on their brilliant documentation platform.
