Skip to content

Commit

Permalink
add ubuntu installation to xestjs.com
Browse files Browse the repository at this point in the history
  • Loading branch information
ammarhashad committed Sep 24, 2024
1 parent 669d31a commit dc73086
Show file tree
Hide file tree
Showing 5 changed files with 13,583 additions and 7,978 deletions.
61 changes: 60 additions & 1 deletion documentation/docs/installation-ubuntu.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# To install on Ubuntu
---
id: installation-ubuntu
title: Installation on Ubuntu
sidebar_label: Installation - Ubuntu
---

<br/>

Expand Down Expand Up @@ -129,3 +133,58 @@ newgrp docker
```
npm install -g xest
```

After installing the XEST CLI globally, you can now bootstrap your API.

## Bootstrapping Your API

In order to create your API, you need to run the following commmand:

```bash
$ xx [project-name]
```

With one simple command, you will be installing all the necessary packages, utils, middlewares and required modules will be created for you. Have a look at the created directory.

```bash
$ cd project-name
```

to start your Xest API, run

```bash
$ xx run
```

Et voila! You're ready to Xest :)

The project-name directory will be created, node modules and a few other boilerplate files will be installed, and a src/ directory will be created and populated with several core files, forming a new API-directory with the following setup;

```
├── README.md
├── index.js
├── package-lock.json
├── package.json
├── node_modules
├── migrations
├── test
├── .env
├── .eslintignore
├── .eslintrc
├── .gitattributes
├── database.json
├── jsconfig.json
├── Makefile
├── database
│ ├── database-schema.sql
│ └── seed-data.sql
│ └── docker-compose.yml
│ └── test-database.json
└── src
```

`docker-compose.yml` is our local development environment configuration. When you run your application, a MySQL container will be started for you. You can connect to the local database instance by using the credentials listed in the `docker-compose.yml` file.

`database-schema.sql` is where you will define your database schema. It will be a series of CREATE TABLE statements which is used to populate your local development database.

`seed-data.sql` will contain the test data that you want to insert into your database whilst developing or testing your application locally.
6 changes: 3 additions & 3 deletions documentation/docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: installation
title: Installation
sidebar_label: Installation
id: installation-mac
title: Installation on MacOs
sidebar_label: Installation - Mac
---

You should install the XEST CLI first then start working on your project.
Expand Down
Loading

0 comments on commit dc73086

Please sign in to comment.