nguyentuancanh / starknet-website

The main repo for starknet.io

Welcome to starknet.io 👋

This is the official repository for starknet.io. The website is built using a modern tech stack, and we encourage community contributions to the codebase, content and translations.

Features

The StarkNet website includes the following features:

• Responsive design, optimized for both desktop and mobile devices.
• Detailed information about StarkNet and its underlying technology.
• Documentation and resources for developers interested in building on StarkNet.
• Latest news and updates related to the StarkNet ecosystem.
• Community and social media links, for users to stay connected and engaged.

Tech Stack

• Chakra UI for UI components
• React as a JavaScript library for UI
• TypeScript for type-safe JavaScript code
• Algolia for search functionality
• Framer Motion for animations
• Storybook for component development and testing
• Crowdin for translations
• Yarn as the package manager
• NetlifyCMS Give non-technical users a simple way to edit and add content

Getting Started

1. Clone the repository:

   git clone https://github.com/starknet-io/starknet-website.git

2. Change into the repository directory:

   cd starknet-website

3. Install dependencies:

   yarn install

4. Update dynamic data:

   yarn data

5. Run the development server:

   yarn dev

6. Open your browser and visit http://localhost:3000 to see the website running locally.

Contributing to the Code

1. Fork the repository to your own GitHub account.

2. Clone your fork to your local machine and follow the steps in the "Getting Started" section above.

3. Create a new branch for your changes:

   git checkout -b my-feature-branch

4. Make your changes and test them locally.

5. Commit and push your changes to your fork:

   git add .

   git commit -m "Description of my changes"

   git push origin my-feature-branch

6. Create a pull request from your fork's branch to the dev branch of the original repository.

Contributing Translations

We use Crowdin for translations. Visit StarkNet Website on Crowdin to contribute translations for different languages.

1. Sign up for a Crowdin account if you don't have one.
2. Select the language you want to contribute to or request a new language if it's not available.
3. Start translating the strings in the translation editor.
4. Save your changes and submit them for review.

We appreciate all contributions! Your translations will help make the StarkNet website more accessible to people around the world.