-
-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
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,33 @@ | ||
# PiSure Backend Application | ||
|
||
This is the backend application for PiSure, built using Node.js, Express, and MongoDB. | ||
|
||
## Getting Started | ||
|
||
To get started, run the following command: | ||
|
||
`npm start` | ||
|
||
This will start the server and make it available at `http://localhost:3000`. | ||
|
||
## API Endpoints | ||
|
||
The following API endpoints are available: | ||
|
||
* `POST /api/policies`: Create a new policy | ||
* `GET /api/policies`: Get all policies | ||
* `GET /api/policies/:id`: Get a policy by ID | ||
* `PUT /api/policies/:id`: Update a policy | ||
* `DELETE /api/policies/:id`: Delete a policy | ||
|
||
## Testing | ||
|
||
To run tests, use the following command: | ||
|
||
`npm test` | ||
|
||
This will run the tests using Jest. | ||
|
||
## Contributing | ||
|
||
Contributions are welcome! Please submit a pull request with your changes and a brief description of what you've added or fixed. |