Merge pull request #194 from tannerwheeler/skyler.cain/update-readme

README.md / local.env example

README.md

@@ -21,6 +21,12 @@
 - [Backend](/backend/README.md)
 
 ## Helpful Commands
+
+### Environment Variables
+We use dotenv and a local.env to store all environment variables.
+Please copy config/local.env.example to config/local.env and update
+any environment variables.
+
 ### Clear and Re-run Migrations
 Sometimes you need to clear out migrations due to a model change. 
 While we are in early development we've decided to drop and recreate

backend/README.md

@@ -32,7 +32,7 @@ There are 5 major steps to creating or editing an endpoint.
 #### **GET and POST Handlers**
 The following links to the current penalty API handlers. Use this as an example for creating new handlers so everything in the backend follows a similar pattern.
 
-- [Example Penalties API Handler](/backend/internal/server/apis/stats/penalty.go)
+- [Example Penalties API Handler](/backend/internal/server/apis/sports/stats/penalty.go)
 
 4. Add in any handlers to the init function
 ``` go
@@ -59,7 +59,7 @@ The following link is to an example .go file containing methods to be used as an
 2. Create or update the corresponding .yml file to correctly reflect any changes you have made.
 
 3. Use the following linked .yml file to keep the documentation consistent throughout the backend.
-- [Example .yml file](/static/oas/v1/stats/penalties.yml)
+- [Example .yml file](/static/oas/v1/sports/stats/penalties.yml)
 
 ## Adding and Updating Unit Testing for Database Model
 Adding a unit test for a database model. These tests will be using a docker spin up of the actual database for testing the database interfacing functions.

backend/internal/middleware/manager.go

@@ -59,7 +59,7 @@ func Setup(app *fiber.App) {
 		log.Alert("Setting permissive CORS")
 		// CORS https://docs.gofiber.io/api/middleware/cors /
 		app.Use(cors.New(cors.Config{
-			AllowOrigins:     "*",
+			AllowOrigins:     "http://localhost:9002",
 			AllowCredentials: true,
 			AllowMethods:     "POST, GET, OPTIONS, PUT, DELETE",
 			AllowHeaders:     "Accept, Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization, Cookie",

config/local.env.example

@@ -0,0 +1,3 @@
+POWERPLAY_JWT_SECRET=your_secret_here
+POWERPLAY_PASSWORD_KEY=your_secret_here
+POWERPLAY_PORT=9002