Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/srish-ty/project-vanilla
website for event SRC by AICHE chapter NIT Rourkela
https://github.com/srish-ty/project-vanilla
Last synced: 18 days ago
JSON representation
website for event SRC by AICHE chapter NIT Rourkela
- Host: GitHub
- URL: https://github.com/srish-ty/project-vanilla
- Owner: Srish-ty
- License: mit
- Created: 2024-06-03T13:07:03.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-03T15:12:26.000Z (7 months ago)
- Last Synced: 2024-06-04T16:57:22.104Z (7 months ago)
- Language: JavaScript
- Size: 182 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](#contributors-)
[](https://github.com/zepfietje/starware)
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
## DSC NIT Rourkela
[![DSC NIT Rourkela][dsc-nitrourkela]](https://dscnitrourkela.org)
Project Huckleberry
Future Website of DSC NIT Rourkela
View Demo
·
Report Webapp Bugs
.
Report Server Bugs
Table of Contents
## About The Project
### Built With
Following technologies and libraries are used for the development of this
project.
- [Next.js](https://nextjs.org/)
- [Styled-Components](https://styled-components.com/)
## Getting Started
To setup the project locally follow the steps below
### Prerequisites
- [Node.js](https://nodejs.org/en/download/)
```sh
# Homebrew
brew install nodejs
# Sudo apt
sudo apt install nodejs
# Packman
pacman -S nodejs
# Module Install
dnf module install nodejs: # stream is the version
# Windows (chocolaty)
cinst nodejs.install
```
- [pnpm](https://classic.pnpmpkg.com/en/docs/install/)
```sh
npm install -g pnpm
```
- [Git](https://git-scm.com/downloads)
```sh
# Homebrew
brew install git
# Sudo apt
apt-get install git
# Packman
pacman -S git
# Module Install (Fedora)
dnf install git
```
### Contribution guidelines 🎃
---
Our Slack Community: [Slack Invite](http://bit.ly/NITRDevs)
`Contributions are welcome 🎉🎉`
### Local Repository Setup
Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
1. **Fork** the repo on GitHub
2. **Clone** the project to your local system
3. **Commit** changes to your own separate branch
4. **Push** your work back up to your fork
5. Submit a **Pull request** so that we can review your changes
NOTE 1: Please abide by the [Contributing Guidelines](https://github.com/dscnitrourkela/project-huckleberry/blob/main/CONTRIBUTING.md).
NOTE 2: Please abide by the [Code of Conduct](https://github.com/dscnitrourkela/project-huckleberry/blob/main/CODE_OF_CONDUCT.md).
NOTE 3: We follow the following [coventional commit types](https://github.com/pvdlg/conventional-commit-types)
### Running the project.
The project uses pnpm and not NPM. It is strictly advised to stick with pnpm so as to avoid dependency conflicts down the line.
```
## switch to new branch
git checkout -b
## Install Dependencies
pnpm install
## Run the Project
pnpm start
### For ESlint checks
pnpm lint
### For Prettier checks
pnpm prettier
## Build the app for production
pnpm build
```
Following are the commands to remove/add new dependencies using pnpm
```
## Add a new Package
pnpm add package_name
## Remove an existing Package
pnpm remove package_name
## Save Package as a Dev Dependency
pnpm add -D package_name
```
## Roadmap
The following project is in its v1 stage. We are open to new features and suggestions. As of now, following are the features that we plan to integrate.
- Set up time of distribution for automatice certificates distributions.
- Complaint management system for disputes.
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Starware
Project-huckleberry is Starware.
This means you're free to use the project, as long as you star its GitHub repository.
Your appreciation makes us grow and glow up. ⭐
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Srishty M
🚧 📆 📖 🤔 ⚠️
All Contributors
🔧
actions-user
🔧
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
[contributors-shield]: https://img.shields.io/github/contributors/dscnitrourkela/project-huckleberry?style=for-the-badge
[contributors-url]: https://github.com/dscnitrourkela/project-huckleberry/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/dscnitrourkela/project-huckleberry?style=for-the-badge
[forks-url]: https://github.com/dscnitrourkela/project-huckleberry/network/members
[stars-shield]: https://img.shields.io/github/stars/dscnitrourkela/project-huckleberry?style=for-the-badge
[stars-url]: https://github.com/dscnitrourkela/project-huckleberry/stargazers
[issues-shield]: https://img.shields.io/github/issues/dscnitrourkela/project-huckleberry?style=for-the-badge
[issues-url]: https://github.com/dscnitrourkela/project-huckleberry/issues
[license-shield]: https://img.shields.io/github/license/dscnitrourkela/project-huckleberry?style=for-the-badge
[license-url]: https://github.com/dscnitrourkela/project-huckleberry/blob/main/LICENSE
[dsc-nitrourkela]: images/RepoCover.png