Skip to content

Latest commit

 

History

History
198 lines (171 loc) · 4.3 KB

README.md

File metadata and controls

198 lines (171 loc) · 4.3 KB
Raw

HackAtCewitManagementSystem

This is a .NET Core application - a website for Hackathon. It contains both the backend and frontend code for the website. It has some of its APIs exposed so that other applications can fetch data and display on other platforms like the React Native application for Android and iOS users.

Introduction

For development purposes, it can run on localhost. You can also run it on the IP address of your computer found using ifconfig command (for Linux users).

Requirements

  • Desktop / Laptop
  • Browser (Tested on Google Chrome)

Installation

Clone the dev branch and start expo.

git clone < URL >
cd < path >

Open Visual Studio and start the application to run on localhost. If you want it to be accessible to everyone besides your computer, find your IP address using ifconfig (for Linux users) and set it as the host address in Properties/launchSettings.json.

Running the tests

Use Visual Studio's test runner UI to run the tests.

Deployment

Just copy the code to the server and change the host address in Properties/launchSettings.json to the server IP address.

APIs

  • Faq
`GET` `/Faq` Get all the FAQs.
`POST` `/Faq/Add` Add new FAQ (admin).
`PUT` `/Faq/Edit/{id}` Edit existing FAQ (admin).
`DELETE` `/Faq/Delete/{id}` Delete FAQ (admin).
  • Resources
`GET` `/Resources` Get all the Resources.
`GET` `/Resources/{id}` Get a particular Resource.
`POST` `/Resources/Add` Add a new Resource (admin).
`PUT` `/Resources/Edit/{id}` Edit existing Resource (admin).
`DELETE` `/Resources/Delete/{id}` Delete Resource (admin).
  • Schedule
`GET` `/Schedule` Get all the events.
`GET` `/Schedule/{id}` Get details of a particular event.
`POST` `/Schedule/Add` Add a new event (admin).
`PUT` `/Schedule/Edit/{id}` Edit an existing event (admin).
`DELETE` `/Schedule/Delete/{id}` Delete event (admin).
  • Day
`GET` `/Day/{year}/{month}/{day}` Get all the events on this day.
  • Checkin
`GET` `/Checkin` Get the list of checkedin and non-checkedin users (admin).
`POST` `/Checkin` Checkin a user (admin).
  • Videos
`GET` `/Videos` Get all the Videos.
`POST` `/Videos/Add` Add new Video (admin).
`PUT` `/Videos/Edit/{id}` Edit existing Video (admin).
`DELETE` `/Videos/Delete/{id}` Delete Video (admin).
  • LeaderBoard
`GET` `/LeaderBoard` Get the entire leaderboard.
`POST` `/LeaderBoard/Add` Add new participant to the leaderboard (admin).
`PUT` `/LeaderBoard/Edit/{id}` Edit score of a participant on leaderboard (admin).
`DELETE` `/LeaderBoard/Delete/{id}` Delete participant from the leaderboard (admin).

Built With

  • .NET Core - An open-source, general-purpose development platform maintained by Microsoft and the .NET community on GitHub.

Contributing

Please read CEWIT's Code Policy for committing code to GitLab.

Author

  • Rohan Karhadkar