Admin-Panel

An all-use API built in Typescript to perform admin operations on various databases
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

About The Project

Admin-Panel is REST API built in Typescript built for the purpose of performing admin operations on any database be it SQL or NOSQL. The API takes the user's database URL and connects to it.
This API makes use of Molecular a fast, modern and powerful microservices framework for Node.js. It helps you to build efficient, reliable & scalable services. You can perform various CRUD operations with the help of this API.

Built With

• Typescript
• Node
• Molecular

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm
• mysql2
• molecular
• molecular-web

Installation

1. Clone the repo

git clone https://github.com/csivitu/Admin-Panel.git

2. Install NPM packages using (npm or yarn).

Using npm

npm install

Using yarn

yarn install

Note: If installing the packages with npm you get errors use yarn to install them.

Usage

To run this project locally, you can run the following command.

Using npm

npm start

Using yarn

yarn start

API Endpoints

Request Type	Route	Function
GET	/project	To list all the projects present in the database
GET	/project/:name	To get a specific project from the database
POST	/project	To create a new project in the database
PUT	/project/:name	To update anything in the project
DELETE	/project/:name	To delete a project in the database
GET	/export/:project	To a export a project present in our database
GET	/export/:project/:collection	To export a collection present inside the project we are exporting
DELETE	/export/:project/:collection	To delete a collection present in our project
DELETE	/export/:project/:collection/document	To delete an document in a collection
POST	/export/:project/:collection	To add a document in a collection
PUT	/export/:project/:collection	To update a document in a collection

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

License

Distributed under the MIT License. See LICENSE for more information.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

ashikka 💻

Rahil Kabani 💻

This project follows the all-contributors specification. Contributions of any kind welcome!