Skip to content

README.md

Latest commit

 

History

History
110 lines (77 loc) · 3.07 KB

README.md

File metadata and controls

110 lines (77 loc) · 3.07 KB
Raw

Project Talos

Official website of the ASME Chapter of NIT Rourkela, built and maintained by OpenCode, the official Open Source and Cybersecurity Club of NIT Rourkela.

CI License: MIT Prettier

Note: This website is under active development. A "Coming Soon" landing page is served at /.
All development takes place at /playground.

🚀 Tech Stack

  • React + Vite – Lightning-fast UI development
  • Tailwind CSS – Utility-first styling
  • React Router – Routing system
  • Prettier + ESLint + Husky – Code quality and consistency
  • GitHub Actions – CI/CD pipeline
  • Netlify – Deployment platform

📦 Installation

Requires Node.js ≥ 18 and npm

# Clone the repo
git clone https://github.com/OpencodeNIT-R/project-talos.git
cd project-talos

# Install dependencies
npm install

# Start development server
npm run dev

📂 Project Structure

project-talos/
├── .github/workflows/         # GitHub Actions workflow
│ └── ci.yml
├── .husky/                    # Pre-commit hooks
├── public/                    # Static assets
├── src/
│ ├── components/              # UI components
│ │ ├── playground/            # Components under active development
│ │ └── shared/                # Reusable components
│ ├── pages/
│ │ ├── landing-page/          # Public home page
│ │ └── playground/            # Route-based development space
│ ├── App.jsx
│ ├── main.jsx
│ └── index.css
├── .eslint*
├── .prettier*
├── .gitignore
├── vite.config.js
├── package.json
├── index.html
├── LICENSE
└── README.md

🤝 Contributing

We welcome all contributions — code, design, docs, or ideas!

Please read our CONTRIBUTING.md for detailed guidelines on:

  • Setting up the project locally
  • Commit message conventions
  • Formatting and linting
  • Pull request process

You can also open issues to suggest features or report bugs.

💬 Community & Support

For queries, reach out to @OpencodeNIT-R

🛡 License

Licensed under the MIT License

👥 Maintainers

Architected with ❤️ by OpenCode, NIT Rourkela