Welcome to the official repository for the TPHxSRMIST Main Website. This website serves as the digital hub for The Product House (TPH) community at SRM Institute of Science and Technology (SRMIST), bringing together tech enthusiasts, developers, and creative minds.
Built with TypeScript, Next.js, Nodemailer, Sanity, Tailwind CSS, and App-Router, this website reflects our commitment to using cutting-edge technologies.
Follow these steps to get the project up and running on your local machine:
-
Clone the repository:
git clone https://github.com/0xsrmist/Main-Website.git
-
Navigate to the project directory:
cd Main-Website -
Install dependencies using pnpm:
pnpm install
-
Set up your environment variables by creating a
.env.localfile. Use the provided.env.sampleas a reference. -
Start the development server:
pnpm run dev
-
Open your browser and visit http://localhost:3000 to view the website.
We welcome contributions from the community. To contribute to the project, follow these quick steps:
-
Fork the repository.
-
Create a new branch for your feature or bug fix:
git checkout -b feature/new-feature
-
Make your changes and commit them:
git commit -m "Add new feature" -
Push your changes to your fork:
git push origin feature/new-feature
-
Open a pull request, and your changes will be reviewed.
-
Contribution Guidelines: If you're interested in contributing to the project, please follow the guidelines outlined in CONTRIBUTING.md.
-
In-Depth Guide to Sanity CMS: For detailed instructions on adding new documents to Sanity, refer to our GitHub Wiki. This guide provides a step-by-step flow to ensure a seamless content management experience.
This project is licensed under the MIT License.
Many people have contacted us asking if they can use this code for their own websites. The answer to that question is usually "yes", with attribution. There are some cases, such as using this code for a business or something that is greater than a personal project, that we may be less comfortable saying yes to. If in doubt, please don't hesitate to ask us.
We value keeping this project open source, but as you all know, plagiarism is bad. We actively spend a non-negligible amount of effort developing, designing, and trying to perfect this iteration of our project, and we are proud of it! All we ask is to not claim this effort as your own.
So, feel free to fork this repo. If you do, please just give us proper credit by linking back to this repo, https://github.com/0xsrmist/Main-Website. Refer to this handy quora post if you're not sure what to do. Thanks!
- TypeScript for enhanced development.
- Next.js for a powerful React framework.
- Nodemailer for sending emails.
- Sanity for structured content management.
- Tailwind CSS for utility-first styling.
- App-Router for efficient routing.
Feel free to explore and contribute to make this website a vibrant space for our community!