A curated list of starter templates for popular web frameworks.
The idea of this repository is to allow newcomers to a particular web framework to have a look at what a sample project in that framework might look like, what the best practices are, and how code should be structured in that framework for it's corresponding language.
.
├── <Language-1>
│ ├── <Framework-1>
│ │ ├── basic-CRUD-api
│ │ │ └── README.md
│ │ ├── basic-CRUD-app
│ │ │ └── README.md
│ │ └── hello-world-app
│ │ └── README.md
│ ├── <Framework-2>
│ │ └── ...
│ └── README.md
└── README.md
Please maintain this structure while adding other projects.
The README.md files inside each application directory must have detailed steps to set-up and run that application.
| Method | Url | Description | Response | Error |
|---|---|---|---|---|
| GET | /hello |
Display Hello World | 200 |
| Method | Url | Description | Response | Error |
|---|---|---|---|---|
| GET | / |
Display index or website running |
200 (Ok) | |
| GET | /users |
Display a list of all users | 200 (Ok) | |
| POST | /users |
Add a user | 201 (Created) | |
| GET | /users/{user-id} |
Display details of user with id=user-id |
200 | 404 (Not Found) |
| PUT | /users/{user-id} |
Update details of user with id=user-id |
200 (Ok) or 204 (No Content) |
404 (Not found) |
| DELETE | /users/{user-id} |
Delete user with id=user-id |
200 (Ok) | 404 (Not Found) |
| GET | /users/search |
Search users by username | 200 (Ok) |
| Method | Url | Description | Response | Error |
|---|---|---|---|---|
| GET | / |
Return {status: "Running"} |
||
| GET | /api/users |
Return a list of all users | ||
| POST | /api/users |
Add a new user | ||
| GET | /api/users/{user-id} |
Return user with id=user-id | ||
| PUT | /api/users/{user-id} |
Update user with id=user-id | ||
| DELETE | /api/users/{user-id} |
Delete user with id=user-id | ||
| GET | /api/users/search |
Search users by username |
| Column | Type | Constraints |
|---|---|---|
| id | int | autoincrement primary key |
| username | text | unique |
| age | integer | |
| name | text |
- Python
This is not a tutorial, therefore the individual README files need not contain installation steps for that particular language. It can be assumed that a user would know how to install the compiler/interpreter of a language before jumping onto learning a framework in that language. However, the installation steps, if any, for frameworks must be written in the README files so that anyone can follow the steps and get their server up and running in their local machines.
To start contributing, check out CONTRIBUTING.md. New contributors are always welcome to support this project.