environment setup for local dev, updated readme (#410)

make it so that new devs cant just run the code without deliberately
moved the env variables, this makes sure they are aware of the proxy
server for CORS and what the env variables are

Co-authored-by: wil <wil@storyteller.ai>
This commit is contained in:
wilandwil authored and GitHub committed 2024-05-21 14:11:10 -04:00
1 parent 00383db9fa
commit 5592bc82b0
3 files changed
+37 -12

No files matched your search

+5
View File
@@ -0,0 +1,5 @@
BASE_API="http://localhost:3000"
GOOGLE_API="http://localhost:3000/google"
FUNNEL_API="http://localhost:3000/funnel"
CDN_API="http://localhost:3000/cdn"
EXPRESSIONS="true"
+1
View File
@@ -1,3 +1,4 @@
.env
node_modules
/~/
/.cache
+31 -12
View File
@@ -1,9 +1,13 @@
# Storyteller GGF
## Coding Rules and Styles
```
Short Style Guide TS React and Engine:
No use of lets
No basic for loop operators.
No basic for loop operators.
Use the collection operators and array operators.
React Side / No modules over 200 lines. ( loose rule )
@@ -19,23 +23,38 @@ if (condition) {
No use of any type.
If you can use chat gpt to create the interface.
```
# Local Testing
use the .env file that directs all requests to localhost:3000
from folder /proxy run
```node proxy.js```
## Local Testing & Development
### Set up `.env` and the Proxy Server
# IF YOU ARE WORKING ON THIS PROJECT PLEASE ASK THE TEAM MEMBERS HOW TO SET UP THIS IS OUTDATED INFORMATION
# GottaGoFast-SS
Fast Prototyping with Better Netlify Pipeline:
Copy & paste the env settings from `.env-local-proxy` to `.env`, (if the file `.env` do not exist, simply create one at the root of this project's folder beside the other env settings files).
- [Remix Docs](https://remix.run/docs)
- [Netlify Functions Overview](https://docs.netlify.com/functions/overview)
- [Tailwind Docs](https://tailwindcss.com/docs)
The settings from `.env-local-proxy` directs all requests to `localhost:3000`, this relieve us from having to deal with CORS between various services.
Then, start the proxy server in the folder `/proxy`
```
node proxy.js
```
### Run the Code Locally
To setup and run this project's code locally:
Setup
```
npm install
npm run dev
```
## Other Documentation
This project uses Remix for routing and Tailwind for styling:
- [Remix Docs](https://remix.run/docs)
- [Tailwind Docs](https://tailwindcss.com/docs)
On Netlify, we use functions:
- [Netlify Functions Overview](https://docs.netlify.com/functions/overview)