/open-tacos

Rock climbing route catalog (openbeta.io)

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

OpenBeta logo

OpenBeta v0.4

Open source. Rock climbing. Catalog.

We're building the first free and open source rock climbing catalog.
The project is currently in MVP stage.
We'd love to hear your feedback. Chat with the dev team on Discord.

Develop branch   License

Screenshot

OpenBeta screenshot

Tech stack

  1. Backend GraphQL API (openbeta-graphql): Apollo GraphQL,MongoDB, Node.js.

  2. Frontend (this repo): React.js, Next.js, TailwindCSS.

High level architecture

Architecture overview

Live instances

Env Link Branch Content Build
Prod https://tacos.openbeta.io develop Complete DB Develop branch

How to build

Make sure you have the following tools installed on your computer:

Important: For frontend development you don't need to set up the Graph API server unless you intend to work on both.

  1. Download the repo to your local machine
git clone git@github.com:OpenBeta/open-tacos.git
  1. Build the code
cd open-tacos
git checkout develop
yarn install
  1. Run the app
yarn dev

The application is now available at http://localhost:3000

Alternate build method using Docker

If you just want to run the app locally without installing node, npm, etc., you can do so with Docker.

Requirements: Docker

docker compose up

The application is now available at http://localhost:3000. The project will rebuild automatically when you make changes to files in ./src dir.

Note: If you install new NPM packages, you will need to rebuild the docker image with

docker compose up --build

The application is now available at http://localhost:3000

Tips

API key errors

Some parts of the code such as user authentication and photo upload require API keys. Without them you'll see a bunch of errors in the log. If you want to work on those tasks, email viet at openbeta.io for API keys. See OpenBeta#389 for more info.

Full stack dev

By default, your dev environment connects to our hosted GraphAPI. To connect your environment to the Graph API server running locally:

yarn dev-local

How to contribute

See our general How to contribute guide for more details.

Support Us

OpenBeta is free because we want to make climbing information accessible for everyone. Please consider making a donation today.

Contributors

Thanks goes to these wonderful people:

Viet Nguyen
Viet Nguyen

💻
Greg Hughes
Greg Hughes

💻
on3iropolos
on3iropolos

🤔 💵
Kevin Nadro
Kevin Nadro

💻
rytheranderson
rytheranderson

💻 🖋
Yannick Gingras
Yannick Gingras

🤔 🖋
Kendra Gibbons
Kendra Gibbons

💻
Gal Weinstock
Gal Weinstock

💻
Clinton Lunn
Clinton Lunn

💻 🤔
MichaelDimmitt
MichaelDimmitt

💻 🤔
Nate Hearnsberger
Nate Hearnsberger

💻 🤔
tittaenalg
tittaenalg

💻
Colin Gale
Colin Gale

💻 🤔
Kurk Villanueva
Kurk Villanueva

💻
umaxyon
umaxyon

💻
Jacob Struzik
Jacob Struzik

💻
Kevin
Kevin

💻
Osaf
Osaf

💻
xavier-kong
xavier-kong

💻
Brendan Downing
Brendan Downing

💻
admanny
admanny

💻
alex
alex

💻 🤔
Denis Lantsman
Denis Lantsman

💻
BeaulieuC
BeaulieuC

🎨 🤔
Daniel
Daniel

🤔
Prajwal
Prajwal

💻
Jetse Verschuren
Jetse Verschuren

💻 🤔
Siman Shrestha
Siman Shrestha

💻
Marcos A Rosas
Marcos A Rosas

💻
Kellen Busby
Kellen Busby

💻 🤔
Leonardo Montini
Leonardo Montini

💻
Matthew D'Souza
Matthew D'Souza

💻
Ilya Shaplyko
Ilya Shaplyko

💻
Chris Morin
Chris Morin

💻
Kittipong
Kittipong

💻
Evan Noronha
Evan Noronha

🐛
ted
ted

💻 🤔

This project follows the all-contributors specification. Contributions of any kind welcome.

License

AGPL