Skip to content

This project is designed to quickly generate documentation for your api

Notifications You must be signed in to change notification settings

Repugraf/docgen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

82 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

To make project work you need to do the following

1. Install mongodb locally. To do that run following commands (Linux):

  • sudo apt install -y mongodb || to install mongodb
  • sudo systemctl enable mongodb || to make mongodb server run on startup
  • sudo service mongodb start || to start mongodb server (if not started)

2. Install all dependencies (frontend and backend) by running npm run install-all

3. Create .env file in root folder. The app will need this environment variables:

  • DB_URL=mongodb://localhost:27017/docgen #(!is required!)
  • PORT=3000 #(optional)
  • MAIL_CONNECTION_JSON

About

This project is designed to quickly generate documentation for your api

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published