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.

Sign up for GitHub

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

Jump to bottom

feat: add next steps guide #192

Merged
merged 1 commit into from
Feb 23, 2024
Merged

feat: add next steps guide #192

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 45 additions & 0 deletions docs/getting-started/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,3 +224,48 @@ of its options and also how to define your own properties inside of it
check out the full [Athenna RC file documentation](/docs/getting-started/athennarc-file).

:::

## Next steps

Now that you have created your Athenna project, you may be
wondering what to learn next. First, we strongly recommend
becoming familiar with how Athenna works by reading the
following documentation:

- [Application lifecycle](/docs/architecture-concepts/application-lifecycle)
- [Configuration](/docs/getting-started/configuration)
- [Directory structure](/docs/getting-started/directory-structure)
- [Service container](/docs/architecture-concepts/service-container)
- [Facades](/docs/architecture-concepts/facades)

How you want to use Athenna will also dictate the next steps
on your journey. Since Athenna has different kind of applications,
there are a variety of ways to use Athenna, and we'll explore
the available ones bellow.

:::tip

New to Athenna? Check out the [Athenna YouTube channel](https://www.youtube.com/@athennaio)
for an infinity of hands-on videos!

:::

### REST API application

Use the REST API Application to serve as an API backend to single page application
or mobile apps. In this context you may use Athenna for data storage / retrieval
for your REST API, while also taking advantage of Athenna's powerful services such
as database, emails, notifications, and more.

If this is how you plan to use Athenna, you may want to check out our documentation
on [routing](/docs/rest-api-application/routing) and the [ORM](/docs/orm/getting-started).

### Command Line Interface (CLI) application

Use the command line interface (CLI) application to create libraries like `athenna`
for NPM where other developers could install it in their terminal. In this context
you may use Athenna for automatting process or generating files, while also taking
advantage of all Athenna's powerful foundation.

If this is how you plan to use Athenna, you may want to check out our documentation
on [commands](/docs/cli-application/commands).
Loading