Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ShindouMihou authored May 27, 2022
1 parent adbc578 commit 1ecf5a0
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# 💮 Flora
A simple, markdown-based blog platform written completely in Typescript, Sveltekit and Tailwind. Unlike other platforms, Flora aims to be simple and minimal but still being beautiful with the help of tools like Bionic Reading to enable superior reading speeds.
![image](https://user-images.githubusercontent.com/69381903/170740789-518da8d9-0c95-4532-9311-9bd5450097a6.png)
<div align="center">
A simple, markdown-based blog platform written completely in Typescript, Sveltekit and Tailwind.
</div>

## 📦 Installation
#
### 📦 Installation
You can setup your own instance of Flora by following the steps below:

Clone the repository:
Expand All @@ -14,6 +17,8 @@ Configure the required configurations:
cp .env.example .env && nano .env
```

> **Warning**
>
> All of the configurations are required to be configured otherwise there will be issues, please take note especially of the ones with `_SECRET` or `_SIGNATURE` since those especially need to be hidden to yourself. **Don't expose them!!!**
Install MongoDB with Docker (optional if you have one already):
Expand All @@ -27,11 +32,15 @@ After installing MongoDB, you need to configure the MONGO_URI in `.env`:
nano .env
```

> **Note**
>
> If you used the MongoDB Docker steps above then you can use the following:
> ```java
> mongodb://<SECRET DATABASE USERNAME>:<SECRET DATABASE PASSWORD>@172.17.0.1:27017/?authSource=admin
> ```
> **Note**
>
> Remember to use the Docker machine host address: `172.17.0.1` when writing your connection address.
You can then start building the docker image for Flora and run the application:
Expand All @@ -42,12 +51,12 @@ docker run -d -i -t -p 3000:3000 --env-file .env --name flora flora:latest
Flora should now be running at `https://localhost:3000` (to change the port, change the value of `-p`: `-p <machine port>:3000`).

## 📖 Creator Dashboard
### 📖 Creator Dashboard
You can access Flora's creator dashboard which is located on `/creator/`. You'll be redirected to the login page (`/creator/login`) if you are not logged in. After that, you can create new articles, delete, update and whatever you like. Although Flora won't host any images whatsoever which means you need to upload the images somewhere.

If you want to log-out of the creator account then you can head to `/creator/logout` which should log you out of the creator account.

## 🖼️ SEO
### 🖼️ SEO
Flora supports a minimal amount of SEO which is configured on `.env` file, those SEO properties will be reflected on all pages except for the creator pages and also the articles themselves (which have their own SEO based on the content).

Articles uses the following SEO properties:
Expand All @@ -56,7 +65,7 @@ Articles uses the following SEO properties:
- `content`: The first 165-characters content written.
- `article:author`: The value configured in `VITE_DISPLAY_NAME` in `.env` file.

## 🚡 State of Flora
### 🚡 State of Flora
Flora is far from reaching stable release and at the moment is on development versions with the following features and functionalities implemented or missing:
- [x] Home (`/`) and Post (`/posts/:id`) pages.
- [x] HTTP API for getting posts and creating posts.
Expand All @@ -81,5 +90,5 @@ Article Page
![image](https://user-images.githubusercontent.com/69381903/170739943-04572b03-ea2a-4b17-92f5-0847121f7381.png)
</details>

## 💌 Show Flora some love!
### 💌 Show Flora some love!
If you like and is using Flora then feel free to show the project some love by adding a star to the repository or by enabling `VITE_FLORA_BANNER` in your configuration which will show the `made with FLORA` banner at the top of your page (will not be shown again if the user opts to hide it).

0 comments on commit 1ecf5a0

Please sign in to comment.