1. Install luaonbeans-cli

First, you need to install the Lua on Beans CLI globally using npm:

npm install -g luaonbeans-cli

2. Create a New Project

Once the CLI is installed, you can create a new empty project using the following command:

beans new my-project

Replace "my-project" with your desired project name.

3. Set Up ArangoDB

Lua on Beans uses ArangoDB as its database. You can easily set it up using Docker Compose:

1. Ensure you have Docker and Docker Compose installed on your system.
2. Navigate to your project directory in the terminal.
3. Run the following command to start ArangoDB in detached mode:

docker compose up arangodb -d

Next Steps

With these steps completed, you now have a new Lua on Beans project set up with ArangoDB running. You're ready to start building your web application!

Check out our documentation for more information on how to structure your project, create routes, and interact with the database.

4. Configure Database Connection

To connect your application to ArangoDB, you need to configure the database settings. Follow these steps:

1. Navigate to the config folder in your project directory.
2. Locate the database.json.arangodb.sample file.
3. Create a copy of this file and rename it to database.json.
4. Open database.json in your preferred text editor.
5. Update the file with your ArangoDB connection details. Here's an example configuration:

{
  "system": {
    "db_name": "_system",
    "url": "http://127.0.0.1:8529",
    "username": "root",
    "password": "password"
  },
  "development": {
    "db_name": "luaonbeans_dev",
    "url": "http://127.0.0.1:8529",
    "username": "root",
    "password": "password"
  },
  "production": {
    "db_name": "luaonbeans",
    "url": "http://127.0.0.1:8529",
    "username": "root",
    "password": "password"
  },
  "test": {
    "db_name": "luaonbeans_test",
    "url": "http://127.0.0.1:8529",
    "username": "root",
    "password": "password"
  },
  "engine": "arangodb"
}