https://github.com/stnguyen90/places

Places
https://github.com/stnguyen90/places

appwrite location-based maps react

Last synced: 2 months ago
JSON representation

Places

• Host: GitHub
• URL: https://github.com/stnguyen90/places
• Owner: stnguyen90
• License: bsd-2-clause
• Created: 2022-05-06T23:27:24.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-27T16:59:52.000Z (over 1 year ago)
• Last Synced: 2024-04-15T03:07:51.460Z (9 months ago)
• Topics: appwrite, location-based, maps, react
• Language: TypeScript
• Homepage: https://places.pages.dev
• Size: 710 KB
• Stars: 16
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Places

This app allows users to add comments and photos to locations on a map.

## Getting Started

### Appwrite

The following steps use the [Appwrite CLI](https://appwrite.io/docs/command-line) to set up Appwrite.

1. Create the project via the Appwrite Admin Console

   - ID: places

   - Name: Places

1. Copy the `appwrite.json.default` to `appwrite.json`

1. Deploy the collections

   1. `echo a | appwrite deploy collection`

1. Create an API Key

   1. `appwrite projects createKey --projectId places --name "Places Functions" --scopes documents.read documents.write files.read files.write`

   1. Take note of the `secret`

1. Deploy the functions

   1. Update variables in the `appwrite.json`:

      1. `APPWRITE_FUNCTION_ENDPOINT` - your HTTPS Appwrite endpoint

      1. `APPWRITE_FUNCTION_API_KEY` - the `secret` from the previous step

   1. Compile each of the functions in the `appwrite-functions` folder:

      1. Go into the function folder

      1. Run `npm i && npm run build`

   1. Go back up to the folder with `appwrite.json` and deploy all the functions:

      1. `echo a | appwrite deploy function`

1. Create the storage buckets

   1. `appwrite storage createBucket --bucketId photo-uploads --name "Photo Uploads" --fileSecurity true --permissions 'create("users")' --enabled true --maximumFileSize 5000000 --encryption true --antivirus true --allowedFileExtensions jpg png heic jpeg`

   1. `appwrite storage createBucket --bucketId photos --name "Photos" --fileSecurity false --permissions 'read("any")' --enabled true --maximumFileSize 5000000 --encryption true --antivirus true --allowedFileExtensions jpg png heic jpeg`

### Places App

1. Copy the `.env` to `.env.local`

1. Fill in the values in `.env.local`

1. Start the app:

   1. `npm i && npm start`