c17df709a6 | ||
---|---|---|
.husky | ||
assets | ||
public | ||
src | ||
.dockerignore | ||
.env | ||
.eslintrc.json | ||
.gitignore | ||
.prettierrc | ||
Dockerfile | ||
Jenkinsfile | ||
README.md | ||
apollo.config.js | ||
codegen.ts | ||
next.config.js | ||
package.json | ||
tsconfig.json | ||
yarn.lock |
README.md
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
-
Unbody : CMS
Environment Variables
Please check the environment values in .env
located in the root directory.
UNBODY_API_KEY=
UNBODY_PROJECT_ID=
SIMPLECAST_ACCESS_TOKEN=
REVALIDATE_WEBHOOK_TOKEN=
NEXT_PUBLIC_SITE_URL=https://press.logos.co
This is a template for .env.local
, which is included in .gitignore
.
You can obtain an Unbody API key and project ID through your Unbody project.
To find the Simplecast access token, follow these steps on the Simplecast dashboard:
-
Click the gear button in the top-right corner.
-
Select
Private Apps
to acquire your JWT bearer token.
How to Run Locally
- Clone this repository
$ git clone https://github.com/acid-info/logos-press-engine.git
- Install the dependencies:
$ yarn install
- Start the development server:
$ yarn dev
- Visit
http://localhost:3000
in your browser
How to Run a Static Build (Production Build)
- Generate static files for production:
$ yarn build
The static files will be created in the build
directory.
- Serve the static build:
$ yarn start
- 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
-
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 (https://dev-press.logos.co/).
-
When ready to promote changes to the live website, create a pull request against the "master" branch, based on the "develop" branch.