ZenBrowserMirrors/www
1
0
Fork 0
mirror of https://github.com/zen-browser/www.git synced 2025-07-08 01:10:02 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore(docs): have better docs

Browse source
This commit is contained in:
Augustin Mauroy 2024-08-21 10:31:32 +02:00
parent 5d4ed0956f
commit 60d493750e
2 changed files with 73 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

61
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,61 @@
# Zen Browser Website
Thank you for wanting to contribute to Zen Browser Website. We are thrilled to welcome you to our community. Before you start, please read this document to understand how you can contribute to this project.
## How to Contribute
1. Fork the Zen Browser Website repository.
2. Clone the Zen Browser Website repository to your local machine.
```bash
git clone git@github.com:<YOUR_GITHUB_USERNAME>/www.git # SSH
git clone https://github.com/<YOUR_GITHUB_USERNAME>/www.git # HTTPS
gh repo clone <YOUR_GITHUB_USERNAME>/www # GitHub CLI
```
3. Change directory to the cloned repository.
```bash
cd www
```
4. Create a branch for your contribution.
```bash
git checkout -b <BRANCH_NAME>
```
5. Start the development environment.
```bash
npm install # or your favorite package manager
npm run dev
```
6. Make your changes.
7. Once you're done, commit your changes.
```bash
git add .
git commit -m "Your commit message"
```
> [!NOTE]
> Please follow the commit guidelines described below.
## Commit Guidelines
This project follows the [Conventional Commits][] specification.
Commits must be signed. You can learn more about [Commit Signing][] here.
### Commit Message Guidelines
- Commit messages must include a "type" as described in Conventional Commits
- Commit messages **must** start with a capital letter
- Commit messages **must not** end with a period `.`
- Commit messages **must** be in English _sorry for the constraint_
[Conventional Commits]: https://www.conventionalcommits.org/
[Commit Signing]: https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits

57
README.md
View file

@ -1,48 +1,15 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://www.zen-browser.app/logos/zen-alpha-white.svgg">
<img src="https://www.zen-browser.app/logos/zen-alpha-black.svg" width="64px">
</picture>
</p>
<h1 align="center">
Zen Browser Website
</h1>
## Getting Started
This repository contains the source code for the Zen Browser Website. We are thrilled to welcome you to our community. Before you start, please read this document to understand how you can contribute to this project.
First you need to install the dependencies:
It's built with [Next.js](https://nextjs.org/), [TypeScript](https://www.typescriptlang.org/), and [Tailwind CSS](https://tailwindcss.com/).
```bash
npm install
# or
yarn install
# or
pnpm install
# or
bun install
```
Then, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
If you are interested in contributing to this project, please read the [Contributing Guidelines](./CONTRIBUTING.md).