Welcome to the NIBM Computing Society website repository. This website is built using Next.js as the frontend framework and Sanity as the content management system (CMS).
NIBM Computing Society is a student community organization for the National Institute of Business Management (NIBM) in Sri Lanka. Our mission is to enable students to learn, share, and build their careers in the field of computing and technology.
- Responsive and modern web design
- Dynamic content management using Sanity CMS
- Upcoming events and news updates
- Membership and contact information
- Community leaderboard
- Next.js - A React framework for building fast and scalable applications.
- Sanity - A headless CMS that provides a powerful and flexible content backend.
- Tailwind CSS - A utility-first CSS framework for rapidly building custom designs.
Follow these steps to set up and run the project locally:
-
Clone this repository to your local machine:
git clone https://github.com/nibmcs/nibmcs.org.git cd nibmcs.org
-
Install the dependencies:
Before running the application, you need to install the project's dependencies. This can be done using Node.js. If you haven't already installed Node.js, you can download it from the official website.
npm install
-
Configure Sanity:
To manage content for the NIBM Computing Society website, you'll need to set up your own Sanity account and project.
Create an account & make a new project. Get project ID and run this:
npm create sanity@latest -- --project zn7egx85 --dataset production --provider google
If you have questions or need assistance with Sanity, please refer to the official Sanity documentation or contact Sanity support for guidance.
-
Local Development:
You can choose one of the following methods for local development:
Using Docker:
If you prefer to use Docker for local development, follow these steps:
# Build the Docker image docker build -t nibmcs-website . # Run the Docker container docker run -p 3000:3000 nibmcs-website
This will build a Docker image for the website and run it on port 3000. After running the container, you can access the website by opening your web browser and visiting http://localhost:3000.
Local Development (Without Docker):
If you prefer not to use Docker, you can run the application using Node.js. Make sure you have Node.js installed on your machine. Just run:
# Start the development server npm run dev
This will start the application without Docker, and you can access it by opening your web browser and visiting http://localhost:3000.
We welcome contributions from the community to improve the NIBM Computing Society website. If you'd like to contribute, please follow these guidelines:
- Fork this repository.
- Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
orgit checkout -b bugfix/issue-number
. - Make your changes and commit them with descriptive commit messages.
- Push your changes to your fork:
git push origin feature/your-feature-name
. - Open a pull request to the
main
branch of this repository.
We will review your pull request and collaborate with you to merge it into the project.
This project is licensed under the MIT License - see the LICENSE file for details.
If you have any questions, suggestions, or need assistance, please feel free to contact us:
- Email: [email protected]
- Twitter: @nibmcs
- LinkedIn: NIBM Computing Society
We look forward to hearing from you and appreciate your contributions!