Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
v-kamelowy authored Oct 2, 2022
1 parent 70f6fb3 commit dc96923
Showing 1 changed file with 14 additions and 27 deletions.
41 changes: 14 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
# Getting Started with Create React App
# 🌍🗺 Welcome to Openguess!

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
You can play right now on https://openguess.pl/ or host it all by yourself!

## Available Scripts
`DISCLAIMER! The tutorial below is not 100% done, a few things will not work right now because of it!`
###### for example i need to find my postgres script to make user profiles on supabase and paste it here but i am lazy as f...

## How to host it? Here ya go:

First, you need to fill out the `.env.local` with your informations.\
Openguess uses https://supabase.com/ as backend, so you will need to create a free project there.\
Google Maps JavaScript API Key is the second thing you need.\
It might be quite expensive, so remember to cap the quota to not go beyond the free 200$ you get every month for free.\

In the project directory, you can run:

Expand All @@ -11,14 +19,6 @@ In the project directory, you can run:
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
Expand All @@ -27,20 +27,7 @@ It correctly bundles React in production mode and optimizes the build for the be
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
## If you want to host the API too, just open a new terminal window in API's directory and run
### `npm start`

To learn React, check out the [React documentation](https://reactjs.org/).
**Congratulations! You are good to go and play Openguess locally, or host it to the public.**

0 comments on commit dc96923

Please sign in to comment.