Skip to content

A modern, open-source platform dedicated to preserving and teaching the Sylheti language and culture. Built with Next.js and designed for the community.

License

Notifications You must be signed in to change notification settings

codewithashim/Syloti

🌿 Syloti

Your Sylhet, your language β€” Learn Sylheti, practice Nagri script, ask AI, explore Sylhet β€” all public and free.

A modern, open-source platform dedicated to preserving and teaching the Sylheti language and culture. Built with Next.js and designed for the community.

✨ Features

  • πŸ“š Interactive Lessons β€” Learn Sylheti through structured, engaging lessons
  • ✍️ Nagri Script Practice β€” Master the Sylheti Nagri writing system
  • πŸ€– AI Assistant β€” Get help with translations, grammar, and language questions
  • πŸ—ΊοΈ Tourism Guide β€” Explore the beautiful region of Sylhet

πŸš€ Tech Stack

πŸ“‹ Prerequisites

  • Node.js 18+
  • npm, yarn, pnpm, or bun

πŸ› οΈ Getting Started

Installation

# Clone the repository
git clone https://github.com/codewithashim/Syloti.git
cd Syloti

# Install dependencies
npm install
# or
yarn install
# or
pnpm install
# or
bun install

Development

Run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

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

The page auto-updates as you edit files. The project uses hot-reload for instant feedback.

Build

Create an optimized production build:

npm run build

Start Production Server

npm start

Lint

Run the linter:

npm run lint

πŸ“ Project Structure

Syloti/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ app/                 # Next.js App Router
β”‚   β”‚   β”œβ”€β”€ layout.tsx       # Root layout with Header & Footer
β”‚   β”‚   β”œβ”€β”€ page.tsx         # Home page
β”‚   β”‚   └── globals.css      # Global styles
β”‚   β”œβ”€β”€ components/
β”‚   β”‚   └── shared/          # Shared components
β”‚   β”‚       β”œβ”€β”€ Header.tsx   # Navigation header
β”‚   β”‚       └── Footer.tsx   # Footer component
β”‚   └── features/            # Feature-based modules
β”‚       └── home/
β”‚           β”œβ”€β”€ Home.tsx
β”‚           └── hero/
β”‚               └── HeroSection.tsx
β”œβ”€β”€ public/                  # Static assets
β”œβ”€β”€ package.json
β”œβ”€β”€ tsconfig.json
└── next.config.ts

🎨 Design System

The project uses a green color palette inspired by Sylhet's natural beauty:

  • Primary Green: #1B8A3B
  • Dark Green: #0D4D1F
  • Light Green: #A5D6A7
  • Background: #F5F9F4

🌐 Browser Support

  • Chrome (latest)
  • Firefox (latest)
  • Safari (latest)
  • Edge (latest)

🀝 Contributing

Contributions are welcome! This project is built for the community, by the community.

Please read our Contributing Guide and Code of Conduct before contributing.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

For more details, see CONTRIBUTING.md.

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

For copyright information, see COPYRIGHT.

πŸ“š Documentation

πŸ‘¨β€πŸ’» Developer

Developed by Ashim Rudra Paul

See AUTHORS.md for a complete list of contributors.

πŸ”— Resources

🚒 Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform:

Deploy with Vercel

Check out the Next.js deployment documentation for more details.


Made with ❀️ for the Sylheti community

About

A modern, open-source platform dedicated to preserving and teaching the Sylheti language and culture. Built with Next.js and designed for the community.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 2

  •  
  •