granblue.team/hensei-web
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Justin Edmund 2023-02-01 00:33:50 -08:00
parent d6d63361ad
commit 39155ae448
1 changed files with 17 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -1,32 +1,30 @@
![Header image for hensei-web](README.png) ![Header image for hensei-web](README.png)
hensei-web is the frontend for granblue.team, an app for saving and sharing teams for [Granblue Fantasy](https://game.granbluefantasy.jp). hensei-web is the frontend for granblue.team, an app for saving and sharing teams for [Granblue Fantasy](https://game.granbluefantasy.jp).
## Getting Started ## Getting Started
First, you have to set up your environment file. `.env.sample` is provided as an example, but here we'll show an even more explicit example for running locally: First, you have to set up your environment file. `.env.sample` is provided as an example, but here are the important bits with notes (you will still need to go to `.env.sample`!)
### App URLs
Don't add a trailing slash to these URLs!
The API will run on port 3000 by default, but make sure to change these to match your instance of the API.
``` ```
# Enable relative paths for imports.
NODE_PATH='src/'
# App URLs
# Don't add a trailing slash to these URLs.
# The API will run on port 3000 by default, but make sure to change
# this if you use a different port.
NEXT_PUBLIC_SIERO_API_URL='http://127.0.0.1:3000/api/v1' NEXT_PUBLIC_SIERO_API_URL='http://127.0.0.1:3000/api/v1'
NEXT_PUBLIC_SIERO_OAUTH_URL='http://127.0.0.1:3000/oauth' NEXT_PUBLIC_SIERO_OAUTH_URL='http://127.0.0.1:3000/oauth'
# This will serve images out of the Next.js /public directory in development,
# but in production, you will want this to host these images on a cloud storage provider
# like Amazon S3, and then change this to the full bucket URL.
NEXT_PUBLIC_SIERO_IMG_URL='/images'
# You will have to use a Google account to acquire a Youtube API key
# or embeds will not work!
NEXT_PUBLIC_YOUTUBE_API_KEY=''
``` ```
Then, install all dependencies: ### Asset URLs
Next.js serves all assets out of the /public directory. In development we utilize this for all assets, but in production, you will want to host these images on a cloud storage provider like Amazon S3. Once you have that set up and you're running in a production environment, change this to the full bucket URL.
```
NEXT_PUBLIC_SIERO_IMG_URL='/images'
```
Once your `.env` is all set up, install all dependencies:
```bash ```bash
npm install npm install
@ -47,7 +45,7 @@ yarn dev
The [hensei-api](https://github.com/jedmund/hensei-api) has tasks that will help you get assets, although some were crafted or renamed by hand. The front-end expects this folder structure inside of the `images` folder: The [hensei-api](https://github.com/jedmund/hensei-api) has tasks that will help you get assets, although some were crafted or renamed by hand. The front-end expects this folder structure inside of the `images` folder:
``` ```
/ root
├─ accessory-grid/ ├─ accessory-grid/
├─ accessory-square/ ├─ accessory-square/
├─ awakening/ ├─ awakening/