Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mskian/quotes-and-status
Share your thoughts: Simply type and post your status updates.
https://github.com/mskian/quotes-and-status
api bulma css express html javascript json notes post-status status-page typescript
Last synced: about 1 month ago
JSON representation
Share your thoughts: Simply type and post your status updates.
- Host: GitHub
- URL: https://github.com/mskian/quotes-and-status
- Owner: mskian
- License: mit
- Created: 2024-12-19T13:14:53.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-19T14:21:22.000Z (about 1 month ago)
- Last Synced: 2024-12-19T14:45:18.891Z (about 1 month ago)
- Topics: api, bulma, css, express, html, javascript, json, notes, post-status, status-page, typescript
- Language: JavaScript
- Homepage:
- Size: 157 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🥤 Status Updates
Share your thoughts: Simply type and post your status updates.
**Note**
I primarily built this tool for personal use, and I mostly run it on my home server or localhost.This tool is not recommended for production use, as it lacks additional security layers such as header authentication, API keys, or token methods to prevent unauthorized access. However, you are welcome to fork the project and make any changes as needed.
## Setup
- Download or Clone the repo
- install dependencies
```sh
pnpm install
```
- Development
```sh
pnpm dev
```
- Build a Project
```sh
pnpm build
```
- Start the server
```sh
pnpm start
```
## Routes
- `/` - Static Home Page for add status, get status by id and get all status
- `/api/status` - API for all operations
## Database
- Create Folder Named `data` and create a JSON file to store the status Content
```sh
mkdir -p data
touch status.json
```
- Add Square brackets to the JSON File
```json
[]
```
- Done
## API Usage
- Add status
```sh
curl -X POST -H "Content-Type: application/json" -d '{"text": "Hello World"}' http://localhost:6027/api/status
```
- Trigger URL to watch the content update
```sh
curl http://localhost:6027/api/status/1 // ID Number
```
- get all status
```sh
curl http://localhost:6027/api/status
```
## LICENSE
MIT