Skip to content
This repository was archived by the owner on Jan 6, 2024. It is now read-only.

Commit 2ded5bb

Browse files
committed
Update README
1 parent 82d6ad0 commit 2ded5bb

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ _Dead simple user account system so easy a ~~caveman~~ **cow** could do it._
44

55
The goal of Accownt is to be a full-featured, standalone account system that's straightforward for developers and users, easy to maintain, and as customizable as possible without introducing too much complexity.
66

7-
![](https://i.imgur.com/c8qHvzy.png)
7+
![](https://i.imgur.com/u6yATTf.png)
88

99
Built and mantained by **[Ptorx](https://ptorx.com)** and other **[Xyfir](https://www.xyfir.com)** projects.
1010

11+
[![Build Status](https://travis-ci.org/xyfir/accownt.svg?branch=master)](https://travis-ci.org/xyfir/accownt)
12+
1113
# Features
1214

1315
- Email + password login
@@ -18,15 +20,12 @@ Built and mantained by **[Ptorx](https://ptorx.com)** and other **[Xyfir](https:
1820
- Email verification
1921
- Plug in your SMTP credentials for Mailgun, Gmail, or anything else
2022
- Account recovery
21-
- Via passwordless login feature
23+
- Account deletion
2224
- No dependencies other than Node and what npm will install
23-
- Older Node versions not actively supported
2425
- No database needed
25-
- Users are simple JSON files stored to disk
2626
- Standalone server and web client
2727
- Easy integration into new and existing applications of any stack
2828
- reCAPTCHA v2 support
29-
- Optional, just set your reCAPTCHA key
3029
- JSON Web Tokens (JWT)
3130
- Shared JWT and cookie between Accownt and your app for session authentication
3231
- Easy theming + light and dark themes
@@ -43,7 +42,7 @@ As simple as Accownt is, you'll still need to install, configure, build, and int
4342
## Step 0: Clone the repo
4443

4544
```bash
46-
git clone https://github.com/Xyfir/accownt.git
45+
git clone https://github.com/xyfir/accownt.git
4746
cd accownt
4847
```
4948

@@ -78,7 +77,7 @@ cp web/example.env web/.env
7877

7978
### Step 2b: Edit `.env` files
8079

81-
Edit the files `server/.env` and `web/.env`. Update the config keys with your own values. You can find descriptions for each one under the `Accownt` -> `Env` namespaces in the [type definitions](https://github.com/Xyfir/accownt/blob/master/types/accownt.d.ts). Use the appropriate `interface` for each corresponding file.
80+
Edit the files `server/.env` and `web/.env`. Update the config keys with your own values. You can find descriptions for each one under the `Accownt` -> `Env` namespaces in the [type definitions](https://github.com/xyfir/accownt/blob/master/types/accownt.d.ts). Use the appropriate `interface` for each corresponding file.
8281

8382
## Step 3: Build from source
8483

@@ -115,12 +114,16 @@ To be a bit more specific:
115114
2. If your app utilizes the JWT cookie that Accownt sets then all you need to do is verify the token with each request via [jsonwebttoken](https://www.npmjs.com/package/jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback) or the equivalent in your preferred language.
116115
3. Once the JWT is verified and decoded, you can retrieve the `userId` and `email` properties from it to use however you need. Note that `userId` is a unix timestamp in milliseconds (13 digits!) that corresponds to when the user created their account. Also keep in mind that if your app is receiving a JWT, the user's email has already been verified.
117116
4. If the JWT is invalid or expired, redirect them back to the Accownt form or to unauthenticated parts of your app.
118-
5. Lastly, you'll need a route somewhere to catch redirections and tokens from Accownt after each successful login. You set this already in your config.
119-
6. Optionally, you can also add a link somewhere that takes _authenticated_ users to Accownt so they can modify their account information, like their password or 2FA.
117+
5. Lastly, you'll need a route somewhere to catch redirections and tokens from Accownt after each successful login. You set this already in your
118+
119+
There are also some optional steps you can take to improve the user experience:
120+
121+
1. You can also add a link somewhere that takes _authenticated_ users to Accownt so they can modify their account information, like their password or 2FA.
122+
2. You can allow users to delete their accounts by configuring the proper environment variables.
120123

121124
# Example
122125

123-
A working example can be found in [Ptorx](https://github.com/Xyfir/ptorx).
126+
A working example can be found in [Ptorx](https://github.com/xyfir/ptorx).
124127

125128
# Contribute
126129

0 commit comments

Comments
 (0)