/kucc-website

An open-source web application project for Kathmandu University Computer Club being built with ReactJS.

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

KUCC WEBSITE

Website Link

Hacktoberfest month is on!!

Let's celebrate the HACKTOBERFEST MONTH by contributing to our very own KUCC Website.

Steps:

1. Any contribution is highly appreciated.

2. Want to contribute/request change? Create an issue and ask for the mod to assign it to you and upon approval, work on it and create a PR.

3. Don't forget to star the repo.

Image showing successful acceptance of the PR in the Hacktoberfest. image

🛠️ Installation Steps

1. Fork the project. Click on the icon in the top right to get started

2. Clone the project, you can use the following command:

Using HTTPS
git clone https://github.com/<your-github-username>/kucc-website
or using SSH
git clone git@github.com:<your-github-username>/kucc-website.git

3. Navigate to the project directory

cd kucc-website

🥂 After making a change

1. Create a new branch

git checkout -b YourBranchName

2. Add it to staging area

git add <path to the file you worked on>

3. Commit your changes with

git commit -m '<your-commit-message'

4. Push your changes

git push -u <remote-name> <branch-name>

👩🏽‍💻 Contributing

  • Contributions make the open source community such an amazing place to learn, inspire, and create.
  • Any contributions you make are greatly appreciated.

🙏🏽 Support

This project needs a star️ from you. Don't forget to leave a star✨

KUCC Website is an open-source web application project for Kathmandu University Computer Club being built with ReactJS.

PHASE 1

  • Homepage
  • Our Team section
  • Code of Conduct section
  • Contact section
  • Events Section
  • Member Application Section

PHASE 2

  • Publications (Blogs, IT Express)

Running locally in development mode

To get started, just clone the repository and run npm install && npm run dev:

git clone https://github.com/kucc1997/kucc-website.git
npm install
npm run dev

Note: If you are running on Windows run install --noptional flag (i.e. npm install --no-optional) which will skip installing fsevents.

Building and deploying in production

If you wanted to run this site in production, you should install modules then build the site with npm run build and run it with npm start:

npm install
npm run build
npm start

You should run npm run build again any time you make changes to the site.

Note: If you are already running a webserver on port 80 (e.g. Macs usually have the Apache webserver running on port 80) you can still start the example in production mode by passing a different port as an Environment Variable when starting (e.g. PORT=3000 npm start).

How to contribute?

  • Submit bugs and feature requests
  • We also welcome code contribution to this project. To do the code contributions please follow these steps.
    • Choose an existing issue labelled as help wanted, good first contribution, easy fix or create your own issue.
    • Fork this repository.
    • Clone the forked repository to your machine.
    • Create a new branch named after the issue you're working on.
    • Commit your changes, push the changes to GitHub.
    • Open a pull request here

License

KUCC Website is BSD 3-Clause licensed, as found in the LICENSE file.