Skip to content

Repository files navigation

Background

This repository holds the code for a generic project website by Binary Bond Labs. It’s a starter template you can adapt for showcasing projects and experiments.

This repository can also be used as a starter template for a Next.js project. The code in this repository is freely distributed.

Some interesting things you can learn from this template:

  • Deployment of Next.js static website to Github Pages.
  • Github Workflows
  • CI/CD pipeline setup
  • TypeScript with React.js and Next.js
  • Integration of linters and formatters.

You can also use this template to create and host a free website on Github Pages or any other static website host. Advantages of a static website:

  • Speed 🚀
  • Security 🛡️
  • Scalability 🙌

Requirements:

Node: >=16

Getting Started

First, Create an environment file (.env) in the root of the project. You can get the initial file by copying env.sample to .env

Second, run the development server:

npm install
npm run dev

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

Contributing

See CONTRIBUTING.md on how to contribute to this project.

Future Plan

We would like to reach to a place where anyone can fork this template, make few changes, and create a free website. For this to happen, following needs to happen:

  • All text should be read from markdown files.
  • User interface can be changed easily.

License

The MIT License (MIT)

Replace any third‑party brand names and assets with your own before distribution. The rest of the repository is open under MIT.

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages