Skip to content

Commit 749a086

Browse files
authored
Update README.md
1 parent dfcc7f0 commit 749a086

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
1-
A novelty website written entirely in Rust.
2-
3-
The Joooooooke is that I'm putting an exceptional amount of effort into creating a production-quality webapp just for Joe.
1+
A novelty website/demo written entirely in Rust.
42

53
The backend uses Rocket (WebServer) + Diesel (ORM).
6-
The frontend uses Yew (React-like framework).
4+
The frontend uses Yew (React/Elm-like framework).
75

86
External dependency management is handled with Nix/Nixos.
97

108
# Planned Features
11-
W@J intends to support the following features:
9+
1210
* User accounts.
1311
* "News" article viewing and authoring via markdown.
14-
* A forum system for talking about Joe.
12+
* A forum system.
1513
* A Bucket Questions game implementation.
16-
* Chat system, so you can talk to Joe.
14+
* Chat system.
1715

1816
# Status
1917
* User accounts, authentication, articles, forum system, and bucket questions game are implemented on the backend.
2018
* The implementation of a chat system is being finalized.
2119
* ~Bucket questions will require Websockets, so while a REST API is exposed to work with them, much of that functionality will migrate there once set up.~ Bucket questions just use HTTP.
2220
* BucketQuestions, Forums, Auth, and Some user features are implemented in the frontend.
2321
* The chat system, articles, user management, and password resets are not yet implemented in the frontend.
24-
* An alpha will be released in the near feature.
22+
23+
* Development is mostly suspended at the moment. This project currently serves as an example on how to use Rust to create an integrated webserver + webapp. Development has slowed due to a lack of interest, time, and the fact that this stack suffers greatly from excessively long compiletimes, which makes it hard to work on.
2524

2625
# Build Instructions
27-
* Initial setup : https://github.com/hgzimmerman/WeekendAtJoes4/wiki/Initial-setup
28-
* Release instructions: https://github.com/hgzimmerman/WeekendAtJoes4/wiki/Release-Instructions
26+
* Initial setup : https://github.com/hgzimmerman/FullstackRustDemo/wiki/Initial-setup
27+
* Release instructions: https://github.com/hgzimmerman/FullstackRustDemo/wiki/Release-Instructions

0 commit comments

Comments
 (0)