Skip to content

Commit da0e18b

Browse files
committed
updated manual
1 parent 59438f7 commit da0e18b

File tree

2 files changed

+35
-2
lines changed

2 files changed

+35
-2
lines changed

.foxxignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.idea/
2+
.git/
3+
.svn/
4+
.hg/
5+
*.swp
6+
.DS_Store

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,38 @@ So, instead of having complex logic describing complete API endpoint functionali
1111

1212
### Getting started
1313

14-
Just `git clone` the whole thing, and you are good to go.
14+
1. `git clone` the whole thing, and you are good to go.
1515

1616
```sh
17-
git clone https://github.com/skitsanos/foxx-builder.git
17+
$git clone https://github.com/skitsanos/foxx-builder.git
1818
```
1919

20+
In package.json in *scripts* section you will find a number of shortcuts that will help you register your server with foxx-cli, and install or replace Foxx microservice on your server.
21+
22+
2. Install foxx-cli if you don't have it yet [https://github.com/arangodb/foxx-cli#install](https://github.com/arangodb/foxx-cli#install)
23+
24+
3. Register your ArangoDB server so you can install and replace your Foxx Microservices, for example:
25+
26+
```sh
27+
$foxx server set dev http://dev:sandbox@localhost:8529
28+
```
29+
30+
By executing this command, we assume that you already created a user _dev_ with password _sandbox_ on _localhost_ server, and we register this server to foxx-cli as _dev_.
31+
32+
If you define servers using the `server` commands, a `.foxxrc` file will be created in your `$HOME` directory, which is typically one of the following paths:
33+
34+
- `/home/$USER` on Linux
35+
- `/Users/$USER` on macOS
36+
- `C:\Users\$USER` on Windows
37+
38+
This file contains sections for each server which may contain server credentials should you decide to save them.
39+
40+
4. The example below shows how you can install this Foxx Microservice on _dev_ server to _dev_ database and mount it as _/api_ endpoint.
41+
42+
```sh
43+
$foxx install /api . --server dev --database dev
44+
```
45+
2046
### Folder Structure
2147

2248
There are very few bits required to make your foxx services up and running. The folder structure defined in a way that will help you to have better control over API application architecture with a minimal coding effort from your side.
@@ -25,6 +51,7 @@ There are very few bits required to make your foxx services up and running. The
2551
/builder/
2652
/foxx/
2753
manifest.json
54+
package.json
2855
index.js
2956
setup.js
3057
```

0 commit comments

Comments
 (0)