https://github.com/epilot-dev/docs
Developer Documentation
https://github.com/epilot-dev/docs
Last synced: 3 months ago
JSON representation
Developer Documentation
- Host: GitHub
- URL: https://github.com/epilot-dev/docs
- Owner: epilot-dev
- Created: 2022-01-16T18:56:06.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T12:56:59.000Z (about 2 years ago)
- Last Synced: 2024-04-11T14:24:55.917Z (about 2 years ago)
- Language: JavaScript
- Homepage: https://docs.epilot.io
- Size: 34.1 MB
- Stars: 11
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# epilot Dev Center
## Quick Start
```
npm install
npm dev
```
The dev command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
## Deployment
The documentation website is hosted by AWS Amplify. All changes merged to the `main` branch are automatically deployed to [docs.epilot.io](https://docs.epilot.io/)
## Local Development
When documenting your APIs, it's possible to perform changes and eval how they look within the docs portal while running locally.
For that, all you need to do is follow the instructions below:
1. `DOCS_URL=http://localhost:3001/ npm run dev` to run the docs portal locally
2. `npm run swagger-ui:watch` to serve your api docs locally on your API project
3. Finally to bypass CORS you will want to get this Chrome [extension](https://chrome.google.com/webstore/detail/moesif-origin-cors-change/digfbfaphojjndkpccljibejjbppifbc)
When you are done, just deploy your `openapi.yml` as you normally would. And don't forget to update your client sdk [here](https://github.com/epilot-dev/sdk-js).