https://github.com/planetarium/libplanet-explorer-frontend
Libplanet Explorer Frontend
https://github.com/planetarium/libplanet-explorer-frontend
hacktoberfest
Last synced: 5 months ago
JSON representation
Libplanet Explorer Frontend
- Host: GitHub
- URL: https://github.com/planetarium/libplanet-explorer-frontend
- Owner: planetarium
- License: mit
- Created: 2019-08-10T13:40:54.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T06:00:49.000Z (5 months ago)
- Last Synced: 2024-11-19T07:17:45.975Z (5 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage: https://explorer.libplanet.io/
- Size: 2.05 MB
- Stars: 16
- Watchers: 12
- Forks: 27
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Libplanet Explorer Frontend
===========================
This project is a user-facing web app, which renders data provided by
a [Libplanet Explorer server][] instance.
[Libplanet Explorer server]: https://github.com/planetarium/libplanet-explorer
Package Management
------------------
This project uses [yarn](https://yarnpkg.com/) 3+ with PnP installs for package management. Please enable yarn as the following:
```bash
corepack enable
```
If you get an error message that looks like this: `-bash: corepack: command not found` please install [corepack](https://nodejs.org/dist/latest/docs/api/corepack.html) and try again:
```bash
npm i -g corepack
corepack enable
```
Also, if you are using an IDE, you might need to setup the editor SDK on yarn for the IDE to work properly. Refer to https://yarnpkg.com/getting-started/editor-sdks for further instruction.
Development (without server)
----------------------------
Copy *.env.development* (which contains the defaults) to *.env.local*, and open the copied *.env.development* file and change the
`NEXT_PUBLIC_GRAPHQL_ENDPOINTS` list to refer to our demo server. The demo server URI can be
found in the first line of *DEPLOYMENTS.tsv*.
Then, install the dependencies and build the app:
~~~~ bash
yarn
yarn dev
~~~~
You can now see the web app from *localhost:3000*.
Development (with server)
-------------------------
First of all, you need to run the server. See the below repository and
then follow the instruction in its README:
If you are sure that your server is ready (check *localhost:5000*)
copy *.env.development* to *.env.local* and build the app:
~~~~ bash
yarn
yarn dev
~~~~
You can now see the web app from *localhost:3000*.
Production
----------
Make a *.env.local* configuration and then build:
~~~~ bash
yarn
yarn build
yarn export
~~~~