Skip to content

Latest commit

 

History

History
89 lines (59 loc) · 3.17 KB

README.md

File metadata and controls

89 lines (59 loc) · 3.17 KB

This directory holds the codebase for a generic website template

Examples for websites using this:

How to build from this template

To create a new webiste from this template:

  1. Fork this repo to where your website code should live
  2. Edit the siteUrl in next-sitemap.js
  3. Edit the EMAIL in src/constants.ts
  4. Make any other changes to the websites content
  5. Run the steps from Verify with docker below to make sure the build will go through
  6. Create a ticket for a new website in ethereum/devops

EF DevOps will then wire up your site to the internet. After thats complete, follow Deployment below on how to get changes to your Site pushed to the internet.

Stack

The main stack used in the project includes:

Local development

The project is bootstrapped with create-next-app, with a custom scaffolding.

Getting Started

First, install dependencies:

yarn install

Then, run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

Verify with docker

to verify how your website will look and feel to the public you can use docker.

  1. Run docker build -t webiste . to build the container image
  2. Run docker run --rm -p 3000:3000 website to launch the container
  3. Naviggate your browser to http://localhost:3000 and check the website.

Deployment

To deploy new changes to your website:

  1. Commit all changes to main
  2. Tag main with a new version (semantic versioning is highly recommended)
  3. Push the tag to GitHub

GitHub Actions will the build the container and trigger a deployemnt onto the EF DevOps container platform.

Project Structure

The following list describes the main elements of the project structure:

  • public: contains static assets like fonts and images.
  • src: contains the source code.
    • components: React components.
      • components with state are directly located inside /components.
      • layout: components used to contain and apply different layouts to different pages.
      • UI: stateless (functional) components.
    • pages: includes components that renders to pages and NextJS API Routes.
    • posts: markdown blog posts.
    • styles: css stylesheets.
      • global.css: global stylesheet.
    • theme: contains the Chakra UI custom theme, organized in foundations and components for better scaling.
    • utils: utilitary stuff.
    • constants.ts: this is the global constants file, containg URLs and lists of elements we use across the site.
    • types.ts: contains the custom defined TypeScript types and interfaces.