Gramex init

To start a Gramex project, run gramex init on your terminal. You should see an output like this:

It initializes a git repository and creates these files:

• README.md: project documentation
• gramex.yaml: Gramex configuration
• index.html: default home page
• login.html: default login page
• style.scss: custom SCSS styles page
• template-navbar.html: default navigation bar
• package.json: npm package file with recommended dependencies

… and a set of configurations that help development.

• .eslintrc.yml info
• .flake8 info
• .gitignore info
• .gitlab-ci.yml info
• .secrets.yml info

Note: gramex init is optional. You can create a Gramex project from scratch by just creating an empty gramex.yaml.

Run gramex. This will start Gramex and show an output like this:

Open http://localhost:9988/ in your browser, and you should see the sample app.

Minimal init

To install the minimal files required to run Gramex, run gramex init minimal on your terminal.

It initializes a git repository and creates these files:

• gramex.yaml: Gramex configuration
• index.html: default home page

Run gramex to see the output.