Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme with beginner-friendly info #57

Merged
merged 1 commit into from
Jul 25, 2024
Merged

Update readme with beginner-friendly info #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,6 @@ yarn-error.log*

# typescript
*.tsbuildinfo

# IDEs
.idea/
28 changes: 26 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,38 @@

[![Deployment Status](https://github.com/WillNilges/meshforms/actions/workflows/publish-and-deploy.yaml/badge.svg)](https://github.com/WillNilges/meshforms/actions/workflows/publish-and-deploy.yaml)

Forms for [meshdb](https://github.com/andybaumgar/meshdb)
Forms for [meshdb](https://github.com/nycmeshnet/meshdb). Live version hosted at https://forms.grandsvc.mesh.nycmesh.net/

This repo currently powers three separate forms:
- Join Form, used to collect contact information from interested future mesh members
- NN Assign form, used by mesh volunteers to provision network numbers for new installs
- Query form, a legacy interface used by mesh volunteers to query information from meshDB
(use of https://db.grandsvc.mesh.nycmesh.net/admin/) is recommended instead for new workflows

# Development

You need a copy of `meshdb` running locally
You will either need a copy of `meshdb` running locally, or point your local copy of this package to the beta/production
endpoints in order to do development:
- To setup against beta/prod, continue to the next section and use `https://db.grandsvc.mesh.nycmesh.net` as the value for `NEXT_PUBLIC_MESHDB_URL`
- To setup a local copy of meshdb, follow the instructions in the readme [there](https://github.com/nycmeshnet/meshdb) first.
Then continue to the next section below and use the value `http://127.0.0.1:8000` for `NEXT_PUBLIC_MESHDB_URL`

To get started with this package, first, create your own copy of the `.env` file:
```
cp .env.sample .env
```

Edit the `NEXT_PUBLIC_MESHDB_URL` based on your choice above in your favorite text editor. For example:
```
nano .env
# Press Ctrl-X and then y to exit
```

Next run the following commands to run the nextjs app on your local machine:
```
npm install

npm run dev
```

Finally, open `http://127.0.0.1:3000` in your web browser to interact with your copy of the application
Loading