acid-info
/
logos-press-engine
mirror of https://github.com/acid-info/logos-press-engine.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
logos-press-engine/README.md

2.1 KiB
Raw Permalink Blame History

Logos Press Engline

The repository for press.logos.co website.

Tech Stacks

  • NextJS : React Framework

  • LSD : Design System

  • Hookstate : State Management

  • Emotion: CSS-in-JS

  • Strapi : CMS

Environment Variables

Please check the environment values in .env located in the root directory.

SIMPLECAST_ACCESS_TOKEN=
REVALIDATE_WEBHOOK_TOKEN=
NEXT_PUBLIC_SITE_URL=https://press.logos.co
FATHOM_SITE_ID=

This is a template for .env.local, which is included in .gitignore.

To find the Simplecast access token, follow these steps on the Simplecast dashboard:

  1. Click the gear button in the top-right corner.

  2. Select Private Apps to acquire your JWT bearer token.

How to Run Locally

  1. Clone this repository
$ git clone https://github.com/acid-info/logos-press-engine.git
  1. Install the dependencies:
$ yarn install
  1. Start the development server:
$ yarn dev
  1. Visit http://localhost:3000 in your browser

How to Run a Static Build (Production Build)

  1. Generate static files for production:
$ yarn build

The static files will be created in the build directory.

  1. Serve the static build:
$ yarn start
  1. Visit http://localhost:3000 in your browser

CI/CD

  • The master branch is automatically deployed to the production server (e.g., logos.co) through CI
  • The develop branch is automatically deployed to the staging server (e.g., dev.logos.co) through CI

Change Process

  1. Create a new working branch from develop: git checkout develop; git checkout -b my-changes.

  2. Make your changes, push them to the origin, and open a Pull Request against the develop branch.

  3. After approval, merge the pull request, and verify the changes on the staging server (https://dev-press.logos.co/).

  4. When ready to promote changes to the live website, create a pull request against the "master" branch, based on the "develop" branch.