https://github.com/json-ms/www
JSON.ms allows you to create an admin panel from a YAML interface that communicates with a remote server using JSON. Users enjoy a sleek interface while you dynamically manage fields through YAML, handling all RESTful requests seamlessly from your server.
https://github.com/json-ms/www
admin json
Last synced: 21 days ago
JSON representation
JSON.ms allows you to create an admin panel from a YAML interface that communicates with a remote server using JSON. Users enjoy a sleek interface while you dynamically manage fields through YAML, handling all RESTful requests seamlessly from your server.
- Host: GitHub
- URL: https://github.com/json-ms/www
- Owner: JSON-ms
- License: bsd-3-clause
- Created: 2025-02-27T18:57:54.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-07T16:31:49.000Z (over 1 year ago)
- Last Synced: 2025-03-07T17:31:40.945Z (over 1 year ago)
- Topics: admin, json
- Language: Vue
- Homepage: https://json.ms
- Size: 255 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSON.ms
JSON.ms allows you to create an admin panel from a YAML interface that communicates with a remote server using JSON. Users enjoy a sleek interface while you dynamically manage fields through YAML, handling all RESTful requests seamlessly from your server.
You don't need to install JSON.ms on your server; you can simply use our [online version](https://json.ms), which connects to your remote server. However, if you're concerned about data security, you have the option to install your own instance.
## Features
- Define admin panel UI using YAML.
- Seamless communication with a remote server via JSON.
- Dynamic field management and typings.
- RESTful API integration.
- File management.
- Multilingual content.
- Data migration.
## Installation
1. Clone the repository:
```sh
git clone git@github.com:JSON-ms/www.git
cd jsonms
```
2. Create a .env file based on .env.example available in the repo:
```sh
cp .env.example .env
```
3. Install dependencies:
```sh
# Using Yarn
yarn
# OR using npm
npm install
```
4. Prepare the environment variables
```ini
# Main JSON.ms server instance
VITE_SERVER_URL=https://localhost:9001
# If running the demo project
VITE_DEMO_PREVIEW_URL=http://localhost:3001
```
5. Start the development server:
```sh
# Using Yarn
yarn dev
# OR using npm
npm run dev
```
## Requirements
Ensure that the backend server ([jsonms-server](https://github.com/JSON-ms/server)) is up and running. See link for setup instructions.
## Documentation
Please check `/docs` folder.
## Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue.
## License
This project is licensed under the BSD-3-Clause License. See the LICENSE file for details.