Skip to content

Latest commit

 

History

History
99 lines (71 loc) · 5.47 KB

README.md

File metadata and controls

99 lines (71 loc) · 5.47 KB
Raw

CodeChef CU Chapter

CodeChef CU Chapter

Issues GitHub pull requests

Table of Content

About CodeChef CU Chapter

CodeChef CU Chapter is the official campus chapter of CodeChef run by the students of Chandigarh University. The aim of the chapter is to open opportunities to all the students in the university to learn from hands-on experience in the industry and getting to learn from professionals working in the industry right now. We are a community which aim to install problem solving aptitude and promote competitive programming while also giving development exposure to all the members.

For more information, visit our official site

About Project

This is the active repository of CodeChef CU Chapter website written in JavaScript using the React.JS library for frontend and Node.JS for the backend. The project is created and maintained by CodeChef CU Chapter. The following are the major pages of the website.

Pages

The project has the following pages:

  • Home: This is the main landing page of the website holding together all the content on the website.
  • About: To give information to the user about the Chapter, vision, mission, values and opportunities available.
  • Team: To give information of the Team of CodeChef and their contact information.
  • Events: To give information about past events, upcoming events and ongoing events.
  • Projects: Home page for the collection of all the projects created by members of the CodeChef CU Chapter Community.
  • Resources: Providing a collection of resources to the user for various domains of Computer Science in one place.
  • Careers: Job postings and opportunities in CodeChef CU Chapter.
  • Membership: Information about membership in CodeChef CU Chapter and call-to-action to be part of the community.
  • Contact Us: Contact page for user to send queries to admin
  • Login: Login page.

Technologies

JavaScript HTML CSS ReactJS NodeJS

Contribution Guidelines

  1. Create an issue using the templates provided answering each of the questions in the template.
  2. The admins and/or will assign the issue accordingly. To get the issue assigned, kindly communicate with the admin.
  3. If assigned, fork the repository and work accordingly.
  4. Once the changes have been made, commit to forked repository
  5. Open Pull Request. Note that the pull request must follow the following:
    • PR must be referenced to the respective issue.
    • PR must pass all tests.

By contributing in the site you agree to the privacy policies and terms of the project.

Deployment

The entire project is deployed at main.cuchapter.tech using Netlify.

Setup

In the project directory, you can use the following commands:

yarn start

Runs the app in the development mode.

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.