Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
K
kus-admin
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Иван Кубота
kus-admin
Commits
8b2ee5eb
Commit
8b2ee5eb
authored
Jul 03, 2020
by
Иван Кубота
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
added readme
parent
23ebf120
Pipeline
#620
canceled with stage
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
56 additions
and
0 deletions
+56
-0
README.md
README.md
+56
-0
No files found.
README.md
0 → 100644
View file @
8b2ee5eb
# Vkusvill Generator
## First run
This project requires node >=v14.4.0
I recommend to use nvm (Node Version Manager) for installing and switching Node versions
Follow the installation guide from the official repository https://github.com/nvm-sh/nvm#installing-and-updating
If there is Node LTS version >=16 - use it instead of 14
After nvm installation - close and reopen terminal and run:
```
shell script
nvm install 14
nvm use 14
nvm alias default 14
```
Node would be installed and configured properly. Read the output, some OS requires adding variables (just follow instructions in output).
### Package manager
```
shell script
npm install -g yarn
```
### Dependencies
Install all dependencies by running
```
shell script
yarn
```
### Configuration
Create .env file and fill it with your config
```
dotenv
KUS_GENERATOR_BACKEND=https://api.vkusvill.flexlab.pro
KUS_GENERATOR_PORT=7890
```
Where KUS_GENERATOR_BACKEND is the URI of backend
### Finally
That's it! Everything is ready for starting backend.
For local start just run
```
shell script
yarn api
```
After Generator API is started - you can see it's methods exposed on
http://localhost:7890/api (set the port same as in .env)
For production run I usually use process-forever
# TODO: write process-forever production manual
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment