Skip to content

Commit

Permalink
improve README in simple example
Browse files Browse the repository at this point in the history
  • Loading branch information
lovasoa committed Jun 11, 2023
1 parent 7ea9457 commit fc85aee
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions examples/simple-website-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,22 @@

This is a very simple example of a website that uses the SQLPage web application framework.

This website illustrates how to create a very Create-Read-Update-Delete (CRUD) application using SQLPage.
This website illustrates how to create a basic Create-Read-Update-Delete (CRUD) application using SQLPage.
It has the following bsic features:

- Displays a list of user names using the [list component](https://sql.ophir.dev/documentation.sql?component=list#component) (in [`index.sql`](./index.sql#L14-L20))
- Add a new user name to the list through a form (in [`index.sql`](./index.sql#L1-L9))
- Add a new user name to the list through a [form](https://sql.ophir.dev/documentation.sql?component=form#component) (in [`index.sql`](./index.sql#L1-L9))
- View an user's personal page by clicking on a name in the list (in [`user.sql`](./user.sql))
- Delete an user from the list by clicking on the delete button in the user's personal page (in [`delete.sql`](./delete.sql))
- Delete an user from the list by clicking on the delete button in the user's personal page (in [`delete.sql`](./delete.sql))

## Running the example

To run the example, just launch the sqlpage binary from this directory.

## Files

- [`index.sql`](./index.sql): The main page of the website. Contains a form to add a new user and a list of all users.
- [`user.sql`](./user.sql): The user's personal page. Contains a link to delete the user.
- [`delete.sql`](./delete.sql): The page that deletes the user from the database, and the redirects to the main page.
- [`sqlpage/migrations/001_create_users_table.sql`](./sqlpage/migrations/001_create_users_table.sql): The SQL migration that creates the users table in the database.
- [`sqlpage/sqlpage.json`](./sqlpage/sqlpage.json): The [SQLPage configuration](../../configuration.md) file.

0 comments on commit fc85aee

Please sign in to comment.