mirror of
https://github.com/acid-info/logos-ordinals-dashboard.git
synced 2025-01-26 21:29:58 +00:00
Siddarth Kumar
fc34d2e200
ci: deploy two branches and use nix
This way we have two branches on GitHub that reflect the state of the website after CI build has finished and pushed.
Logos Ordinals
This is currently at the MVP stage of the project.
Staging: https://logos-ordinals-dashboard.vercel.app/
How to Run Locally
- Clone this repository
$ git clone https://github.com/acid-info/logos-ordinals-dashboard.git
- Install the dependencies:
$ yarn install
- Create a .env file
NEXT_PUBLIC_API_MODE=development
for development
NEXT_PUBLIC_API_MODE=development
- Start the development server:
$ yarn dev
- Visit
http://localhost:3000
in your browser
How to Run a Build (Production Build)
- Generate files for production:
$ yarn build
The files will be created in the build
directory.
- Serve the build:
$ yarn start
- Visit
http://localhost:3000
in your browser.
Keep in mind this webpage rebuilds itself at runtime.
Change Process
-
Create a new working branch from
develop
:git checkout develop; git checkout -b my-changes
. -
Make your changes, push them to the
origin
, and open a Pull Request against thedevelop
branch. -
After approval, merge the pull request, and verify the changes on the staging server.
-
When ready to promote changes to the live website, create a pull request against the "master" branch, based on the "develop" branch.
Description
Languages
TypeScript
98.9%
Nix
0.5%
JavaScript
0.5%
Dockerfile
0.1%