ideclon
/
mastodon_algorithm_frontend
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add README

This commit is contained in:
ideclon 2022-12-22 23:59:40 +00:00
parent e175c2d12c
commit c09470ca9a
Signed by: ideclon
GPG Key ID: 3E186629301AFBFD
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# Mastodon Algorithm - Frontend / Client
This repo contains the frontend for [ideclon's](https://ideclon.uk) Mastodon Algorithm project.
**This project relies on [AppWrite](https://appwrite.io). You must have an AppWrite instance to run this project**
# Deploy frontend
The frontend currently requires PHP, which is solely used for templating, because I know PHP. I plan to replace it with some templating language which will compile to plan HTML at some point.
## Connect to Appwrite
Navigate to your Appwrite instance's UI. Go to Overview > Integrations. Select the Platforms tab and click "Add Platform". Select "Web App" from the dropdown.
Enter a name (this can be whatever you want) and enter the URL of the frontend. Click Next, then Skip optional step.
You'll need to set the following enviroment vars for this project. Alternatively, you could fill in the required variables in `template/footer.php`.
* `APPWRITE_ENDPOINT`: You can find this at Settings > API Credentials > API Endpoint
* `APPWRITE_PROJECT_ID`: You can find this at Settings > API Credentials > Project ID
* `APPWRITE_DB_ID`: You'll need this from when you set up the server components
# Create a user
There's currently no way to create a user from the frontend. You'll need to do so from the Appwrite UI at Auth > Create User.