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: add homepage #179

Merged
merged 1 commit into from
Feb 17, 2024
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion docs/architecture-concepts/application-lifecycle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ service providers is very valuable. Your application's default service providers
are stored in the `providers` directory, and you can create your own provider
with the following command:

```shell
```bash
node artisan make:provider AppProvider
```

Expand Down
4 changes: 2 additions & 2 deletions docs/architecture-concepts/facades.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ The service container binding key is also included where applicable.
First, let's use the following command to create a new [service provider](/docs/architecture-concepts/service-providers)
to resolve our dependency inside the [service container](/docs/architecture-concepts/service-container):

```shell
```bash
node artisan make:provider HelperProvider
```

Expand Down Expand Up @@ -162,7 +162,7 @@ will need to register it inside the `.athennarc.json` file, inside the

Artisan can generate a new facade via the `make:facade` command:

```shell
```bash
node artisan make:facade String
```

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture-concepts/service-container.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ bind your service in the container.

Let's create a simple service to understand how this annotation works:

```shell
```bash
node artisan make:service StringNormalizer
```

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture-concepts/service-providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ contain a `register` and a `boot` method. Within the `register` method, you shou
only bind things into the service container. We will check lately why this
behavior. To create a new provider, use the following command:

```shell
```bash
node artisan make:provider AppProvider
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cli-application/annotations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ public name: boolean

Calling `greet` command setting the `name` option:

```shell
```bash
node artisan greet -n

// Or
Expand All @@ -167,7 +167,7 @@ public name: string

Calling `greet` command setting the `name` option:

```shell
```bash
node artisan greet -n Lenon

// Or
Expand Down
14 changes: 7 additions & 7 deletions docs/cli-application/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Don't worry if this directory does not exist in your
application—it will be created the first time you run the
`make:command` Artisan command:

```shell
```bash
node artisan make:command SendEmails
```

Expand Down Expand Up @@ -65,7 +65,7 @@ If you do so, Athenna will always import and load only that
specific command that you want to execute, meaning that if
you execute the following command:

```shell
```bash
node artisan send:email [email protected]
```

Expand Down Expand Up @@ -372,7 +372,7 @@ export class Greet extends BaseCommand {
}
```

```shell
```bash
node artisan greet <name> <age>
```

Expand Down Expand Up @@ -402,7 +402,7 @@ export class Greet extends BaseCommand {
}
```

```shell
```bash
node artisan greet 22 lenon txsoura
```

Expand Down Expand Up @@ -439,7 +439,7 @@ export class Greet extends BaseCommand {
}
```

```shell
```bash
node artisan greet -n lenon
```

Expand Down Expand Up @@ -485,7 +485,7 @@ export class AthennaPizzeria extends BaseCommand {
}
```

```shell
```bash
node artisan pizza
You ordered a pizza with sauce and mozzarella cheese

Expand Down Expand Up @@ -522,7 +522,7 @@ export class Greet extends BaseCommand {
}
```

```shell
```bash
node artisan greet --names=lenon --names=txsoura
```

Expand Down
2 changes: 1 addition & 1 deletion docs/cli-application/error-handling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ a different formatter.
You can create custom exception by executing the following
Artisan command:

```shell
```bash
node artisan make:exception BadCommandException
```

Expand Down
6 changes: 3 additions & 3 deletions docs/cli-application/publishing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ to create one.
After creating the account, open your terminal and run the
following command in the root of your package:

```shell
```bash
npm login
```

You will get a prompt to enter your `username` and `password`.
If login is successful, you should see a message like this:

```shell
```bash
Logged in as <your-username-here> on https://registry.npmjs.org/.
```

Expand All @@ -39,7 +39,7 @@ Logged in as <your-username-here> on https://registry.npmjs.org/.
Now that you are authenticated, to publish a package to NPM
is very simple, just run the following command:

```shell
```bash
npm publish --access public
```

Expand Down
4 changes: 2 additions & 2 deletions docs/cli-application/running.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ should be on the top of this file.

Now you need to run the following command in your project root:

```shell
```bash
npm link
```

And now the `yourCliCommand` will exist in your actual Node.js version:

```shell
```bash
yourCliCommand --help
```

Expand Down
4 changes: 2 additions & 2 deletions docs/database/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ using a fluent query builder and the ORM.

First of all you need to install `@athenna/database` package:

```shell
```bash
npm i @athenna/database
```

Artisan provides a very simple command to configure the database
library in your project. Simply run the following:

```shell
```bash
node artisan configure @athenna/database
```

Expand Down
10 changes: 5 additions & 5 deletions docs/database/migrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You may use the `make:migration` Artisan command to generate a database migratio
timestamp that allows Athenna to determine the order of
the migrations:

```shell
```bash
node artisan make:migration FlightsMigration
```

Expand Down Expand Up @@ -95,14 +95,14 @@ export class FlightsMigration extends BaseMigration {
To run all of your outstanding migrations, execute the
`migration:run` Artisan command:

```shell
```bash
node artisan migration:run
```

You can use the `--connection` option to run migrations
for a specific connection:

```shell
```bash
node artisan migration:run --connection=postgres
```

Expand All @@ -119,14 +119,14 @@ will run too.
To revert all your migrations, you may use the `migration:revert`
Artisan command. This command will revert all your migrations:

```shell
```bash
node artisan migration:revert
```

You can use the `--connection` option to revert migrations for a
specific connection:

```shell
```bash
node artisan migration:revert --connection=postgres
```

Expand Down
4 changes: 2 additions & 2 deletions docs/database/seeding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To generate a seeder, execute the `make:seeder` Artisan command. All
seeders generated by the framework will be placed in the `Path.seeders()`
directory:

```shell
```bash
node artisan make:seeder UserSeeder
```

Expand Down Expand Up @@ -50,7 +50,7 @@ By default, the `db:seed` command will run all the seeders
inside the `Path.seeders()` folder, but you can run only one seeder
using the `--classes` argument:

```shell
```bash
node artisan db:seed

node artisan db:seed --classes=UserSeeder
Expand Down
4 changes: 2 additions & 2 deletions docs/digging-deeper/repl.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ application on the command line, including your models,
jobs, events, and more. To enter the REPL environment,
run the Artisan command:

```shell
```bash
node artisan repl
```

Expand Down Expand Up @@ -109,7 +109,7 @@ repl
Now the `.greet` command will always be available in your
REPL sessions:

```shell
```bash
.greet Antoine
> Hello Antoine!
```
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ 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
```bash
nvm install 20
```

We recommend setting Node.js v20.x as the default version, to do
so with `nvm` run:

```shell
```bash
nvm alias default 20.8.1
```

Expand Down
10 changes: 0 additions & 10 deletions docs/introduction/_category_.json

This file was deleted.

39 changes: 0 additions & 39 deletions docs/introduction/welcome.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/orm/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To get started, let's create a model. Models typically live in the
class. You may use the `make:model` Artisan command to generate a
new model:

```shell
```bash
node artisan make:model Flight
```

Expand Down
4 changes: 2 additions & 2 deletions docs/rest-api-application/controllers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ To get started, we can use the `make:controller` command's
`--resource` option to quickly create a controller to handle
these actions:

```shell
```bash
node artisan make:controller PhotoController --resource
```

Expand Down Expand Up @@ -114,7 +114,7 @@ Route.resource('photos.comments', 'PhotoCommentController')
This route will register a nested resource that may be
accessed with URLs like the following:

```shell
```bash
/photos/:photoId/comments/:commentId
```

Expand Down
2 changes: 1 addition & 1 deletion docs/rest-api-application/error-handling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ to `404` or the code is `E_NOT_FOUND_ERROR`.
You can create custom exception by executing the following
Artisan command:

```shell
```bash
node artisan make:exception NotFoundResourceException
```

Expand Down
Loading
Loading