Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/franz-dc/beyond-ys
A fan website dedicated to Nihon Falcom's works.
https://github.com/franz-dc/beyond-ys
falcom firebase kiseki nextjs trails wiki ys
Last synced: about 1 month ago
JSON representation
A fan website dedicated to Nihon Falcom's works.
- Host: GitHub
- URL: https://github.com/franz-dc/beyond-ys
- Owner: franz-dc
- License: mit
- Created: 2023-06-08T04:17:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-24T15:34:13.000Z (12 months ago)
- Last Synced: 2024-01-24T16:45:06.823Z (12 months ago)
- Topics: falcom, firebase, kiseki, nextjs, trails, wiki, ys
- Language: TypeScript
- Homepage: https://beyondys.com
- Size: 9.52 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Beyond Ys
A fan website dedicated to [Nihon Falcom](https://www.falcom.co.jp)'s works. You can find information about Falcom's games, characters, music, staff, and more!
## Website
You can visit the site [here](https://beyondys.com).
## Features
- **Music player**: Listen to your favorite Falcom music while browsing the site.
- **Detailed credits**: Know who worked on specific works and music.
- **Themes**: Choose between light and dark theme (defaults to dark).
- **Editable content (WIP)**: Manage content through the editor.
## Technologies Used
- [Next.js](https://nextjs.org): React framework for server-side rendering, static site generation, and incremental static regeneration.
- [Firebase](https://firebase.google.com): Comprehensive development platform providing authentication, real-time database, etc.
- [Material UI (MUI)](https://mui.com): React UI library for building responsive web applications.
- [Vercel](https://vercel.com): Cloud platform for static sites and serverless functions.
## Content Progress
Check out the project's progress regarding content [here](https://relic-beak-0d6.notion.site/d96cfcbbd068490782337f095535e1ae?v=eb1e2dd604364bd2b1fceaac149f0a8c).
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/en/download/)
- [Firebase project](https://firebase.google.com/docs/web/setup) or [Local Firebase Emulator Suite](https://firebase.google.com/docs/emulator-suite/install_and_configure)
### Installation
1. Clone the repository:
```sh
git clone https://github.com/franz-dc/beyond-ys.git
```
2. Install dependencies:
```sh
npm i
# or
yarn
```
3. Create `.env.local` by copying `.env` and replace the values with your own:
```sh
cp .env .env.local
```
4. Set up your **Firebase project** or **Firebase Local Emulator Suite**.
a. **Firebase Project**
1. Make sure that `NEXT_PUBLIC_USE_FIREBASE_EMULATOR` is set to `false` in `.env.local`.
2. Optional: Set `USE_EMPTY_STATIC_PATHS` to `true` in `.env.local`. This is recommended if you're using a free Firebase plan to avoid exceeding the free quota.
3. Create a service account key and download the generated JSON file.
4. Update the values of `FIREBASE_ADMIN_PRIVATE_KEY` and `FIREBASE_ADMIN_CLIENT_EMAIL` in `.env.local` with the values from the JSON file.
5. Make your storage bucket publicly readable. For more information, see [this](https://stackoverflow.com/a/61129057).
b. **Firebase Local Emulator Suite**
1. Make sure that `NEXT_PUBLIC_USE_FIREBASE_EMULATOR` is set to `true` in `.env.local`.
2. Enable the following services in your Firebase project:
- Authentication
- Firestore
- Storage
3. Update Firestore emulator variables in `.env.local` if necessary. This is only needed if you're using a different host or port.
4. Run the following commands on your local Firebase directory to start the emulators:
First time:
```sh
firebase emulators:start --export-on-exit=./emulator-data
```
Subsequent times:
```sh
firebase emulators:start --import=./emulator-data --export-on-exit=./emulator-data
```
This is needed to persist the data in the emulator and avoid having to reseed the database every time you restart the emulator.
5. Run this command to seed the database with sample data\*:
```sh
npm run seed
# or
yarn seed
```
6. Run the development server:
```sh
npm run dev
# or
yarn dev
```
7. Open [localhost:9000](http://localhost:9000) on your browser.
\* _Only canon Ys games are seeded (with some of their characters, music, and staff)._
## Contributing
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure they're properly tested.
4. Commit your changes and push them to your forked repository.
5. Submit a pull request, explaining the changes you've made.
## License
This project is licensed under the [MIT License](https://github.com/franz-dc/beyond-ys/blob/main/LICENSE).