)
[//]: # (
)
[//]: # ( 
)
[//]: # ( )
Portabase
Backup / Restore your databases instances
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
-
About The Project
-
Getting Started
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgments
## About The Project
Portabase is the server dashboard service working with portabase agents.
see Portabase
(back to top)
### Built With
* [![NextJS][NextJS]][NextJS-url]
* [![Prisma][Prisma]][Prisma-url]
(back to top)
## Getting Started
### Prerequisites
Install docker on your machine
### Installation
Installation steps in order to use it locally and work on some features improvements
1. Clone the repo
```sh
git clone https://github.com/Soluce-Technologies/portabase
```
3. Start the project
```sh
docker compose up
```
(back to top)
## Roadmap
- [ ] Add Changelog
- [ ] Improve documentation and repositories
- [ ] Add tests procedure
- [ ] Add Release File
- [ ] Security improvements
- [ ] Multi locale support
- [ ] Multi db support
- [x] PostgreSQL
- [ ] MongoDB
- [ ] MySQL
See the [open issues](https://github.com/Soluce-Technologies/portabase/issues) for a full list of proposed features (and known issues).
(back to top)
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### Top contributors:
(back to top)
## Memo
If you're using Semantic Versioning (SemVer) to version your Docker images, you can use the following format:
```major.minor.patch-rc.release (e.g. 1.0.0-rc.1)```
```major.minor.patch-rc.release-tag (e.g. 1.0.0-rc.1-dev)```
## License
Distributed under the Apache License. See `LICENSE.txt` for more information.
(back to top)
## Contact
Killian Larcher - killian.larcher@soluce-technologies.com
Charles Gauthereau - charles.gauthereau@soluce-technologies.com
Project Link: [https://github.com/Soluce-Technologies/portabase](https://github.com/Soluce-Technologies/agent-portabase)
(back to top)
[NextJS]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Prisma]: https://img.shields.io/badge/Prisma-3982CE?style=for-the-badge&logo=Prisma&logoColor=white
[Prisma-url]: https://www.prisma.io/
[NextJS-url]: https://nextjs.org/