https://github.com/tobysolutions/chess-test
https://github.com/tobysolutions/chess-test
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/tobysolutions/chess-test
- Owner: tobySolutions
- Created: 2025-01-20T10:19:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-20T10:20:01.000Z (over 1 year ago)
- Last Synced: 2025-04-05T08:53:31.147Z (about 1 year ago)
- Language: TypeScript
- Size: 445 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chess on Fleek
Chess on Fleek is perfect for developers looking to deploy real-time, interactive applications. This template utilizes Next.js for a fullstck development experience, rendering, ensuring optimal performance with each move. Shoutout to [Rishabh Singh](https://github.com/rishabh1S) for kickstarting it and maintaining it.
## Prerequisites
- Node 18.18.0+
- Fleek Account
- [Fleek CLI](https://www.npmjs.com/package/@fleek-platform/cli)
- [Fleek Next Adapter](https://www.npmjs.com/package/@fleek-platform/next)
## Getting Started
1. Fork the repository
2. Clone the repository by running the following command:
```bash
git clone https://github.com//chess-on-fleek.git
```
3. Enter the correct directory, install dependencies and run locally:
```bash
cd chess-on-fleek
cd client
npm i
npm run dev
```
3. Ensure that you install the Fleek CLI and the Fleek Next Adapter:
```bash
// local installation
npm i @fleek-platform/cli
npm i @fleek-platform/next
// global installation
npm i -g @fleek-platform/cli
npm i -g @fleek-platform/next
```
💡: you can check the Fleek CLI version by running fleek -v. Any version >= 2.10.1 should be good. As for the Fleek Next adapter, you can check the Fleek Next Adapter version by running fleek-next -v. Any version >= 2.1.0 should be good.
## Building and Deploying
1. Build the project using the Fleek Next Adapter:
```bash
npx fleek-next build
# or if installed globally
fleek-next build
```
2. Now, Create the Fleek Function using the Fleek CLI:
```bash
//syntax
fleek functions create --name ''
//example
fleek functions create --name fumadocs
```
3. Finally, deploy using the Fleek CLI:
```bash
//syntax
fleek functions deploy --bundle=false --path .fleek/dist/index.js --assets .fleek/static --name ''
//example
fleek functions deploy --bundle=false --path .fleek/dist/index.js --assets .fleek/static --name fumadocs
```
As you complete all the steps successfully here, you will be able to access your fullstack Next.js app using a link that looks like this-
https://millions-smartphone-ancient.functions.on-fleek.app/
## Contributing
### Reporting Issues
- Use GitHub Issues to report bugs or suggest features.
- Provide clear details and steps to reproduce any issues.
### Pull Requests
- Fork the repository.
- Create a feature branch:
```bash
git checkout -b feature/your-feature
```
- Commit changes with clear messages.
- Push to your fork and submit a pull request.
## Learn More
- [Fleek CLI Docs](https://fleek.xyz/docs/cli/)
- [Fleek Function Docs](https://fleek.xyz/docs/cli/functions/)
- [Fleek Next Docs](https://fleek.xyz/docs/cli/functions/)
- [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.
- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs