Skip to content

Latest commit

 

History

History
135 lines (99 loc) · 4.33 KB

README.md

File metadata and controls

135 lines (99 loc) · 4.33 KB
Raw

EVerest Admin Panel

Introduction

The EVerest Admin Panel is a beta-stage frontend tool designed for graphically editing the EVerest configuration file and controlling or restarting the EVerest process. It provides a user-friendly interface for managing EVerest instances and includes a simulator for experimenting without an actual EVerest instance.

Table of Contents

Features

  • Edit EVerest Configuration Files: Easily modify your EVerest configuration directly from the admin panel.
  • Connect to Multiple EVerest Instances: Manage multiple instances from a single interface.
  • Simulator: Experiment and learn without the need for a live EVerest instance.
  • Restart EVerest: Restart your EVerest instance with the click of a button.

Demo

We continuously deploy the latest version of the admin panel to GitHub Pages: Demo. This allows you to try out the admin panel without having to install it locally.

For every pull request we deploy a version to https://everest.github.io/everest-admin-panel/pr-<PR_NUMBER> so you can test the changes before a pull request is merged.

Development

  1. Ensure you have pnpm installed on your system.
  2. Clone this repository.
  3. Navigate to the project directory and run:
pnpm install
  • For development purposes, run:
pnpm dev

This will start the development server, making the admin panel accessible on localhost:8080.

  • To build the project, run:
pnpm build
  • To preview the build result, run:
pnpm preview

For instructions on setting up an EVerest instance, refer to the EVerest Quick Start Guide. This is recommended if you're not using the simulator version.

Releasing a new version

To release a new version, follow these steps:

  1. Generate a changelog using cocogitto: cog changelog vX.Y.Z..HEAD. Copy it.
  2. Update the version in package.json.
  3. Commit the changes, the commit message should look like this: chore(release): vX.Y.Z.
  4. Create a new tag with the version number: git tag -a vX.Y.Z. Use the changelog as the tag message.
  5. Push the changes and the tag: git push origin main --follow-tags. For this you need to have the necessary permissions.
  6. The CI will automatically create a GitHub release. Add the changelog to the release description.

Updating the simulator data

Find a detailed guide on how to update the simulator data here.

Documentation

For more information about EVerest, please consult the general documentation. The main EVerest repository can be found here.

Troubleshooting

As the admin panel is currently in its beta stage, bug reports and feedback are highly appreciated. If you encounter any issues, please feel free to open an issue on our GitHub repository.

Contributing

Contributions are welcome! If you'd like to contribute, please:

  1. Create an issue to discuss the changes you propose.
  2. Fork the repository.
  3. Create your feature branch (git checkout -b feature/AmazingFeature).
  4. Commit your changes (git commit -s -m 'feat(some-module): amazing new feature'). Please follow the Conventional Commits standard and sign off your commits using the -s option.
  5. Push to the branch (git push origin feature/AmazingFeature).
  6. Open a pull request.

Please make sure to create an issue before creating a pull request.

Dependencies

The most important technologies used in this project are:

License

This project is licensed under the Apache License Version 2.0, January 2004. For more information, please see the LICENSE file in this repository.