Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tylim88 committed May 2, 2023
1 parent 5c22f28 commit 6071d96
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ Techs:

## Development Mode

1. This project use Firebase Firestore, please enable it in Firebase Console
2. Replace `src/firebase_/config.ts` with your Firebase config.
3. Create a `.env` file at project root and paste `VITE_BASE_URL=http://localhost:3001` into it.
4. `npm run dev` to see the website on `http://127.0.0.1:5173/`
1. Install dependencies with `npm run setup`
1. This project use Firebase Firestore, please enable Firestore in Firebase Console
1. Replace `src/firebase_/config.ts` with your own Firebase config. (Note: This is not a secret but should move to `.env` file to make environment switching easier)
1. Create a `.env` file at project root and paste `VITE_BASE_URL=http://localhost:3001` into it.
1. `npm run dev` to view the website on `http://127.0.0.1:5173/`
1. For Chrome users, Chrome will block localhost with CORS, please install this [Chrome extension](https://chrome.google.com/webstore/detail/allow-cors-access-control/lhobafahddgcelffkeicbaginigeejlf) to allow CORS. Please note that, when the add-on is added to your browser, it is inactive by default (toolbar icon is grey C letter). If you want to activate the add-on, please open the toolbar popup and press the toggle button on the left side. The icon will turn to an orange C letter.

## Production Mode

To be continued
The repo is ready for production, but you will probably go with your tech stack anyway.

Open an issue if you really need one, and I will complete this read me.

0 comments on commit 6071d96

Please sign in to comment.