diff --git a/README.md b/README.md index cec6ea2..39d3243 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ -# Forum App with FastAPI -Model is after 4chan +# Singleboard Forum +A 4ch ripoff, coded as an exercise in learning full stack development with React +and FastAPI. -Board: has threads, unique counter for posts -Thread: Collection of related posts -Post: post_id, thread_id, title, content \ No newline at end of file +## Demo +Start the Docker containers: +``` +docker compose up -d +``` + +Interact with the backend API to add some posts by browsing to http://localhost:8000/docs, +then browse to the frontend at http://localhost:3000.