mirror of
https://github.com/LukeHagar/idn-admin-console.git
synced 2025-12-06 04:20:02 +00:00
Luke Hagar
175
README.md
175
README.md
@@ -1,49 +1,22 @@
|
|||||||
<a id="readme-top"></a>
|
<a id="readme-top"></a>
|
||||||
|
|
||||||
## How to use this template
|
<!-- PROJECT SHIELDS -->
|
||||||
|
|
||||||
Update sheild urls
|
|
||||||
|
|
||||||
* Update url for discourse, downloads, issues, current release, and contributors
|
|
||||||
|
|
||||||
Project title and logo
|
|
||||||
|
|
||||||
* Update project title and description
|
|
||||||
* Update project logo
|
|
||||||
* Update link to point to documentation about this project
|
|
||||||
|
|
||||||
About the project
|
|
||||||
|
|
||||||
* Update project screenshot
|
|
||||||
* Update the paragraph with what your project is meant to accomplish
|
|
||||||
|
|
||||||
Getting started
|
|
||||||
|
|
||||||
* Describe how to get started with your project
|
|
||||||
* Describe any prerequisites needed to run your project
|
|
||||||
* Describe how to install and run your project
|
|
||||||
|
|
||||||
Discuss
|
|
||||||
|
|
||||||
* Create a tag in our discourse forum for your project
|
|
||||||
* Update link in this section to point to the newly created tag
|
|
||||||
|
|
||||||
After these steps are complete remove this checklist!
|
|
||||||
|
|
||||||
[![Discourse Topics][discourse-shield]][discourse-url]
|
[![Discourse Topics][discourse-shield]][discourse-url]
|
||||||
![Times Downloaded][downloads-shield]
|
![Times Downloaded][downloads-shield]
|
||||||
![Issues][issues-shield]
|
![Issues][issues-shield]
|
||||||
![Latest Releases][release-shield]
|
![Latest Releases][release-shield]
|
||||||
![Contributor Shield][contributor-shield]
|
![Contributor Shield][contributor-shield]
|
||||||
|
|
||||||
[discourse-shield]: https://img.shields.io/discourse/topics?label=Discuss%20This%20Tool&server=https%3A%2F%2Fdeveloper.sailpoint.com%2Fdiscuss
|
|
||||||
[discourse-url]: https://developer.sailpoint.com/discuss/tag/workflows
|
|
||||||
[downloads-shield]: https://img.shields.io/github/downloads/sailpoint-oss/api-linter/total?label=Downloads
|
|
||||||
[issues-shield]:https://img.shields.io/github/issues/sailpoint-oss/api-linter?label=Issues
|
|
||||||
[release-shield]: https://img.shields.io/github/v/release/sailpoint-oss/api-linter?label=Current%20Release
|
|
||||||
[contributor-shield]:https://img.shields.io/github/contributors/sailpoint-oss/api-linter?label=Contributors
|
|
||||||
|
|
||||||
[product-screenshot]: ./assets/images/api-linter-output.png
|
<!-- [discourse-shield]: https://img.shields.io/discourse/topics?label=Discuss%20This%20Tool&server=https%3A%2F%2Fdeveloper.sailpoint.com%2Fdiscuss -->
|
||||||
|
[discourse-shield]: https://img.shields.io/badge/Discuss_This_Tool-0033a1
|
||||||
|
[discourse-url]: https://developer.sailpoint.com/discuss/tag/idn-admin-console
|
||||||
|
[downloads-shield]: https://img.shields.io/github/downloads/sailpoint-oss/idn-admin-console/total?label=Downloads
|
||||||
|
[issues-shield]:https://img.shields.io/github/issues/sailpoint-oss/idn-admin-console?label=Issues
|
||||||
|
[release-shield]: https://img.shields.io/github/v/tag/sailpoint-oss/idn-admin-console?label=Current%20Release
|
||||||
|
[contributor-shield]:https://img.shields.io/github/contributors/sailpoint-oss/idn-admin-console?label=Contributors
|
||||||
|
|
||||||
|
[product-screenshot]: ./assets/images/idn-admin-console-output.png
|
||||||
|
|
||||||
<!-- PROJECT LOGO -->
|
<!-- PROJECT LOGO -->
|
||||||
<br />
|
<br />
|
||||||
@@ -52,90 +25,106 @@ After these steps are complete remove this checklist!
|
|||||||
<img src="https://avatars.githubusercontent.com/u/63106368?s=200&v=4" alt="Logo" width="80" height="80">
|
<img src="https://avatars.githubusercontent.com/u/63106368?s=200&v=4" alt="Logo" width="80" height="80">
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<h3 align="center">SailPoint OSS - README - Template</h3>
|
<h3 align="center">IdentityNow Admin Console - README</h3>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
An awesome README template to jumpstart your projects!
|
A desktop application to administer and troubleshoot IdentityNow
|
||||||
<br />
|
<br />
|
||||||
<a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a>
|
<a href="https://github.com/sailpoint-oss/idn-admin-console/issues/new?assignees=&labels=bug&projects=&template=bug-report.md&title=%5BBUG%5D+Your+Bug+Report+Here">Report Bug</a>
|
||||||
<br />
|
|
||||||
<br />
|
|
||||||
<!-- <a href="https://github.com/sailpoint/repo-template">View Demo</a>
|
|
||||||
·
|
·
|
||||||
<a href="https://github.com/sailpoint-oss/repo-template/issues">Report Bug</a>
|
<a href="https://github.com/sailpoint-oss/idn-admin-console/issues/new?assignees=&labels=enhancement&projects=&template=feature-request.md&title=%5BFEATURE%5D+Your+Feature+Request+Here+">Request Feature</a>
|
||||||
·
|
|
||||||
<a href="https://github.com/sailpoint-oss/repo-template/issueschoose">Request Feature</a> -->
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
- [About the project](#about-the-project)
|
||||||
|
- [Get started](#get-started)
|
||||||
|
- [Use a release](#use-a-release)
|
||||||
|
- [Building the application from source](#build-the-application-from-source)
|
||||||
|
- [Contribute](#contribute)
|
||||||
|
- [License](#license)
|
||||||
|
- [Discuss](#discuss)
|
||||||
|
|
||||||
|
|
||||||
<!-- ABOUT THE PROJECT -->
|
<!-- ABOUT THE PROJECT -->
|
||||||
## About The Project
|
## About the project
|
||||||
|
|
||||||
<div align="center">
|
<!-- <div align="center">
|
||||||
<img src="./assets/images/api-linter-output.png" width="500" height="" style="text-align:center">
|
<img src="./assets/images/idn-admin-console-output.png" width="500" height="" style="text-align:center">
|
||||||
</div>
|
</div> -->
|
||||||
|
|
||||||
There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.
|
The IdentityNow Admin Console is a desktop application you can use to administer and troubleshoot IdentityNow. The admin console is built using Electron and Sveltekit, and it is developed and maintained by the SailPoint Developer Relations team.
|
||||||
|
|
||||||
Here's why:
|
The goal of the admin console is to provide a single place to perform common administrative tasks and troubleshoot issues in your IdentityNow tenant.
|
||||||
* Your time should be focused on creating something amazing. A project that solves a problem and helps others
|
|
||||||
* You shouldn't be doing the same tasks over and over like creating a README from scratch
|
|
||||||
* You should implement DRY principles to the rest of your life :smile:
|
|
||||||
|
|
||||||
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!
|
|
||||||
|
|
||||||
Use the `BLANK_README.md` to get started.
|
|
||||||
|
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
<!-- GETTING STARTED -->
|
<!-- GETTING STARTED -->
|
||||||
## Getting Started
|
## Get started
|
||||||
|
|
||||||
This is an example of how you may give instructions on setting up your project locally.
|
To use this tool, you will need to have an IdentityNow tenant.
|
||||||
To get a local copy up and running follow these simple example steps.
|
|
||||||
|
|
||||||
### Prerequisites
|
### Use a release
|
||||||
|
|
||||||
This is an example of how to list things you need to use the software and how to install them.
|
There are built versions of this application available for each major OS platform. You can find the latest release [here](https://github.com/sailpoint-oss/idn-admin-console/releases/latest).
|
||||||
* npm
|
|
||||||
```sh
|
|
||||||
npm install npm@latest -g
|
|
||||||
```
|
|
||||||
|
|
||||||
### Installation
|
Pick your OS and download the relevant file from the latest release:
|
||||||
|
| Platform | File Type |
|
||||||
|
| -------- | --------- |
|
||||||
|
| Windows | exe, zip |
|
||||||
|
| Mac | dmg, zip |
|
||||||
|
| Linux | deb, rpm, zip |
|
||||||
|
|
||||||
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
|
If you want to build the application yourself, follow these steps:
|
||||||
|
|
||||||
1. Get a free API Key at [https://example.com](https://example.com)
|
|
||||||
2. Clone the repo
|
|
||||||
```sh
|
|
||||||
git clone https://github.com/your_username_/Project-Name.git
|
|
||||||
```
|
|
||||||
3. Install NPM packages
|
|
||||||
```sh
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
4. Enter your API in `config.js`
|
|
||||||
```js
|
|
||||||
const API_KEY = 'ENTER YOUR API';
|
|
||||||
```
|
|
||||||
|
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
|
### Build the application from source
|
||||||
|
|
||||||
|
Prerequisites:
|
||||||
|
* To build the application from source you will need NPM installed. You can find instructions on how to install NPM [here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
|
||||||
|
|
||||||
|
Once you have NPM installed, you can clone this repository and run the following commands in the specified order and folders:
|
||||||
|
|
||||||
|
Go to the folder: `./Sveltekit-App`
|
||||||
|
First, run this command:
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
Then run this command:
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
Next, go to the folder: `./Electron-App`
|
||||||
|
First, run this command:
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, run this command:
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
As long as there are no errors during the build process, the built application binaries will then be located in the `./Electron-App/out` folder.
|
||||||
|
|
||||||
|
|
||||||
<!-- CONTRIBUTING -->
|
<!-- CONTRIBUTING -->
|
||||||
## Contributing
|
## Contribute
|
||||||
|
|
||||||
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
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`.
|
If you have a suggestion to improve this project, please fork the repo and create a pull request. You can also make a suggestion by opening an issue with the tag `enhancement`.
|
||||||
Don't forget to give the project a star! Thanks again!
|
Don't forget to give the project a star! Thanks again!
|
||||||
|
|
||||||
1. Fork the Project
|
Follow these steps to make contributions:
|
||||||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
|
||||||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
1. Fork the project.
|
||||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
2. Create your feature branch: `git checkout -b feature/AmazingFeature`
|
||||||
5. Open a Pull Request
|
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.
|
||||||
|
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|
||||||
@@ -148,6 +137,6 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
|
|||||||
|
|
||||||
<!-- CONTACT -->
|
<!-- CONTACT -->
|
||||||
## Discuss
|
## Discuss
|
||||||
[Click Here](https://developer.sailpoint.com/dicuss/tag/{tagName}) to discuss this tool with other users.
|
You can go to the [SailPoint Developer Community Forum](https://developer.sailpoint.com/dicuss/tag/idn-admin-console) to discuss this tool with other users!
|
||||||
|
|
||||||
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
||||||
|
|||||||
Reference in New Issue
Block a user