Open source. Rock climbing. Catalog.
We're building the first free and open source rock climbing catalog.
Take me to the site π
The project is currently in MVP stage.
We'd love to hear your feedback. Chat with the dev team on Discord.
-
Backend GraphQL API (openbeta-graphql): Apollo GraphQL, MongoDB, Node.js.
-
Frontend (this repo): React.js, Next.js, TailwindCSS.
Env | Link | Branch | Content | Build |
---|---|---|---|---|
Prod | https://openbeta.io | develop | Complete DB | |
Staging | https://stg.openbeta.io | develop | Partial |
Make sure you have the following tools installed on your computer:
Important: For frontend development work you don't need to set up the GraphQL API server server project (unless you intend to work on both).
- Download the repo to your local machine
git clone [email protected]:OpenBeta/open-tacos.git
- Build the code
cd open-tacos
git checkout develop
yarn install
- Run the app
yarn dev
The application is now available at http://localhost:3000
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
Some parts of the code such as user profiles, page edit and photo upload require additional 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.
By default, your local dev environment connects to our staging GraphQL API server. To connect your environment to the Graph API server running locally:
yarn dev-local
You might get build errors or be prompted to downgrade your version of TypeScript. This is due to the linter ts-standard
using an older version of TypeScript. You can ignore the warning message.
To commit without passing pre-build tests because you're doing a simple/unrelated change or simply wish to save your work-in-progres, run commit with the --no-verify
flag. Example:
git commit --no-verify -am "saving my work before going climbing"
You might get linting errors when run yarn lint
. To fix this, if you use VS Code, please make sure you have StandardJS
extension installed and enabled.
See our general How to contribute guide for more details.
- Give this repo a star
- Please consider making a donation today to help us pay our infrastructure expenses (> $100/month).
Thanks goes to these wonderful people:
This project follows the all-contributors specification. Contributions of any kind welcome.
AGPL