Skip to content

Commit 99f3457

Browse files
Update readme.md
1 parent c8ce8b5 commit 99f3457

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

readme.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,36 @@
11
# Recipe App
22

3-
A simple CRUD recipe application built with Node.js and Express.
3+
This is a small, purposefully-imcomplete recipe app intended to be used in some Copilot workshops.
44

5-
## Quick Start
5+
- Built with Node.js, Express, Handlebars, and Sqlite.
6+
- Scafholds a database with seed data on first launch.
7+
- Handles the creation, listing, and editing of recipes.
8+
9+
Some ideas of what to add:
10+
11+
- A `/recipes/random` endpoint to select a random recipe.
12+
- A way to delete recipes within the web application.
13+
- A way to search recipes.
14+
- Support for multiple units of measurement on recipes.
15+
16+
## Requirements
17+
18+
This project can be run in a GitHub Codespace or locally with the help of a Dev Container. If you want to run outside of these environments, set up should be the following commands in your terminal:
619

720
```bash
821
npm install
922
npm start
1023
```
11-
1224
Visit `http://localhost:3000` to start managing your recipes.
1325

14-
## Features
26+
## License
27+
28+
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](https://github.com/github-samples/node-recipe-app/blob/main/LICENSE) for the full terms.
29+
30+
## Maintainers
1531

16-
- 📝 Create and edit recipes
17-
- 📋 View all recipes
18-
- SQLite database storage
32+
See maintainers in the [CODEOWNERS](https://github.com/github-samples/node-recipe-app/blob/main/.github/CODEOWNERS) file.
1933

20-
## Tech Stack
34+
## Support & Contributions
2135

22-
- **Backend**: Node.js, Express
23-
- **Database**: SQLite3
24-
- **Views**: Handlebars
25-
- **Styling**: CSS
36+
There is no support for this repositry. It will periodically be updated as the needs for workshops where it is used evolves. We do not currently accept contributions.

0 commit comments

Comments
 (0)