Skip to content

Commit

Permalink
added the doc-beta from lanadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
FotieMConstant committed Sep 22, 2024
1 parent dc8495b commit 0ab0e1a
Show file tree
Hide file tree
Showing 44 changed files with 33,397 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs-beta/.browserslistrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
> 1%
last 2 versions
not dead
not ie 11
1 change: 1 addition & 0 deletions docs-beta/.env_example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
OPENAI_API_KEY=enter_your_api_key_here
19 changes: 19 additions & 0 deletions docs-beta/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
module.exports = {
root: true,
env: {
node: true,
},
extends: [
"plugin:vue/vue3-essential",
"eslint:recommended",
"@vue/typescript/recommended",
// "plugin:prettier/recommended",
],
parserOptions: {
ecmaVersion: 2020,
},
rules: {
"no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
"no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off",
},
};
24 changes: 24 additions & 0 deletions docs-beta/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.DS_Store
node_modules
/dist


# local env files
.env.local
.env.*.local
.env

# Log files
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# Editor directories and files
.idea
.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
27 changes: 27 additions & 0 deletions docs-beta/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# lanadoc

This repository houses the frontend for the [project-lana](https://github.com/FotieMConstant/project-lana), which is developed using vue 3 and typescript. The frontend plays a crucial role in rendering and presenting the generated documentation in a user-friendly manner on a node doc sever.


## Project setup
```
npm install
```

### Compiles and hot-reloads for development
```
npm run serve
```

### Compiles and minifies for production
```
npm run build
```

### Lints and fixes files
```
npm run lint
```

### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).
3 changes: 3 additions & 0 deletions docs-beta/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: ["@vue/cli-plugin-babel/preset"],
};
34 changes: 34 additions & 0 deletions docs-beta/lana.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"theme": "moon",
"sourcePaths": {
"routes": ["../routes/quote_route.js"],
"implementation": ["../controllers/quote_controller.js"]
},
"metaInfo": {
"info": {
"title": "Geek Quote API",
"version": "1.0.0",
"description": "The Quote API is a service that provides a collection of inspirational quotes. You can use this API to retrieve random quotes, filter quotes by keywords, and explore the wisdom of known authors.",
"termsOfService": "https://example.com/terms",
"contact": {
"name": "fotiecodes",
"email": "[email protected]",
"url": "https://fotiecodes.com"
},
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0"
}
},
"servers": [
{
"url": "https://geek-quote-api.vercel.app",
"description": "Production server"
},
{
"url": "https://localhost:3000",
"description": "Developement server"
}
]
}
}
Loading

0 comments on commit 0ab0e1a

Please sign in to comment.