https://github.com/decentfox/freeauth-doc
https://github.com/decentfox/freeauth-doc
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/decentfox/freeauth-doc
- Owner: decentfox
- Created: 2023-07-24T04:02:07.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-17T01:39:31.000Z (almost 3 years ago)
- Last Synced: 2025-01-28T20:34:41.932Z (over 1 year ago)
- Language: TypeScript
- Size: 7.58 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Make authentication and authorization easy and free.
# Documentation of [FreeAuth](https://github.com/decentfox/freeauth-api)
We are using [Docus](https://docus.dev) to write our documentation.
## Setup
Clone the repository and install dependencies:
```bash
yarn install
```
## Development
Start the development server on [http://localhost:3000](http://localhost:3000)
```bash
yarn dev
```
## Edge Side Rendering
Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments.
Look at all the available presets [here](https://nuxt.com/docs/getting-started/deployment#presets).
```bash
yarn build
```
## Static Generation
Use the `generate` command to build your application.
The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.
```bash
yarn generate
```
## Preview build
You might want to preview the result of your build locally, to do so, run the following command:
```bash
yarn preview
```
---
For a detailed explanation of how things work, check out [Docus](https://docus.dev).