Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(nodev): support versions above v20.x #133

Merged
merged 1 commit into from
Oct 16, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@ How to install and set up your first Athenna project.

### Prerequisites

First, you need to install [Node.js](https://nodejs.org/) v20.x. We
recommend using [nvm](https://github.com/nvm-sh/nvm) to do
that.
First, you need to install [Node.js](https://nodejs.org/).
We recommend using [nvm](https://github.com/nvm-sh/nvm) to do that.

> [Click here to install nvm and get npm and Node.js
running on your machine.](https://github.com/nvm-sh/nvm#installing-and-updating)

After you install `nvm`, you can install Node.js v20.x by running:
After you install `nvm`, we recommend you to install
Node.js v20.x or above, this is the current version that
the project is being developed, but you can still use
Node.js v16.x and above. Install Node.js v20.x by running:

```shell
nvm install 20
Expand All @@ -29,7 +31,7 @@ We recommend setting Node.js v20.x as the default version, to do
so with `nvm` run:

```shell
nvm alias default 20.8.0
nvm alias default 20.8.1
```

### Installing via package manager
Expand All @@ -39,7 +41,7 @@ Athenna. With that in mind, we developed a CLI to assist
in the creation of a new project.

```bash
npm install @athenna/cli -g
npm install -g @athenna/cli
```

Then you can run this command to generate your project:
Expand Down Expand Up @@ -67,11 +69,8 @@ and configure the packages to work with it.

## Running your application

To run your application you can simply use the node script in
your project root. Don't worry about this file for now, we'll
talk about it later.

In your project root, run the following command:
To run your application in development mode,
run the following command:

```bash
node --watch artisan serve
Expand Down
Loading