-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #82 from Asymtode712/ClgLect
[New API]: College_Lectures_API
- Loading branch information
Showing
7 changed files
with
1,232 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# College Lecture Management API | ||
|
||
This is a simple API for managing college lectures. It allows users to search for a particular lecture of their college. | ||
|
||
# Getting Started | ||
|
||
# Prerequisites | ||
- Node.js installed on your local machine | ||
- npm (Node Package Manager) installed with Node.js | ||
|
||
# Installation | ||
- Clone the repository to your local machine | ||
- Navigate to the project directory | ||
- Install dependencies: `npm install` | ||
|
||
# Usage | ||
|
||
- Start the server: `node index.js` | ||
|
||
- The server will start running on port 3000 by default. You can change the port by setting the PORT environment variable. | ||
|
||
- Access the API endpoints using tools like cURL, Postman, or your preferred HTTP client. | ||
|
||
|
||
# Sample Data | ||
|
||
The API comes with sample lecture data for demonstration purposes. You can modify or extend this data as needed in the index.js file. |
Oops, something went wrong.