Skip to content

Commit 36b0f30

Browse files
committed
feat: minor config and index page
1 parent 7a618bb commit 36b0f30

File tree

5 files changed

+80
-83
lines changed

5 files changed

+80
-83
lines changed

app/layout.jsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ const navbar = (
1515
<>
1616
<Image src="/favicon-32x32.png" alt="Fastfony icon" width="32" height="32" />
1717
<span style={{ marginLeft: '.4em', fontWeight: 800 }}>
18-
Fastfony Documentation
19-
</span>
18+
Fastfony Documentation
19+
</span>
2020
</>
2121
}
22-
// ... Your additional navbar options
22+
projectLink="https://github.com/fastfony/fastfony"
2323
/>
2424
)
25-
const footer = <Footer>MIT {new Date().getFullYear()} © Fastfony.</Footer>
25+
const footer = <Footer>{new Date().getFullYear()} © Fastfony.</Footer>
2626

2727
export default async function RootLayout({ children }) {
2828
return (
@@ -43,7 +43,7 @@ export default async function RootLayout({ children }) {
4343
<Layout
4444
navbar={navbar}
4545
pageMap={await getPageMap()}
46-
docsRepositoryBase="https://github.com/fastfony/fastfony-docs/tree/main/docs"
46+
docsRepositoryBase="https://github.com/fastfony/docs/tree/main/docs"
4747
footer={footer}
4848
// ... Your additional layout options
4949
>

content/get-started.mdx

Lines changed: 0 additions & 72 deletions
This file was deleted.

content/index.mdx

Lines changed: 71 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,72 @@
1-
# Welcome to Fastfony Docs
1+
# Get started with Fastfony
22

3-
Hello, world!
3+
Fastfony is a Symfony boilerplate and starter kit that provides a solid foundation for building web applications. It includes a variety of features and tools to help you get started quickly and efficiently.
4+
5+
## Prerequisites
6+
7+
Before you begin, ensure you have the following installed on your machine:
8+
9+
1. [PHP](https://www.php.net/manual/en/install.php),
10+
2. [Composer](https://getcomposer.org),
11+
3. [Symfony CLI](https://symfony.com/download),
12+
4. [Node](https://nodejs.org/en/download),
13+
5. [Docker & Docker Compose](https://docs.docker.com/compose/install/) and
14+
6. [Taskfile](https://taskfile.dev/installation/)
15+
16+
Be careful to the minimum versions requirements:
17+
18+
- PHP: 8.2
19+
- Symfony CLI: 5.11
20+
- Node: 22 with npm and _npx_
21+
22+
## Create new project
23+
24+
We recommend creating a new development project on a local development machine and follow the "Go to production" (soon available...) instructions to deploy it on a production server.
25+
26+
You can create a new project using one of the following methods:
27+
28+
### Solution 1 : From archive
29+
30+
Extract the download archive and in the root of the project, run the following command:
31+
32+
```bash
33+
git init
34+
git add .
35+
git commit -m "Initial commit"
36+
```
37+
38+
If you want synchronize your new project with the template repository of Fastfony or Fastfony Pro, run the following command:
39+
40+
For Fastfony:
41+
42+
```bash
43+
curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- https://github.com/fastfony/fastfony
44+
```
45+
46+
For Fastfony Pro:
47+
48+
```bash
49+
curl -sSL https://raw.githubusercontent.com/coopTilleuls/template-sync/main/template-sync.sh | sh -s -- [email protected]:fastfony/fastfony-pro.git
50+
```
51+
52+
And then resolve conflicts, if any, and run `git cherry-pick --continue`.
53+
54+
Then, run the following command:
55+
56+
```bash
57+
task start
58+
```
59+
60+
### Solution 2 : From template repositories
61+
62+
Go on github in order to create your own repository from the template, with this link:
63+
* for Fastfony: https://github.com/new?template_name=fastfony&template_owner=fastfony
64+
* for Fastfony Pro: https://github.com/new?template_name=fastfony-pro&template_owner=fastfony
65+
66+
You can claim your access to the Fastfony Pro repository by sending e-mail to [email protected].
67+
68+
Then clone the repository and in the root of the project, run the following command:
69+
70+
```bash
71+
task start
72+
```

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"dependencies": {
33
"flexsearch": "^0.8.143",
44
"next": "^15.2.3",
5-
"nextra": "^4.2.16",
6-
"nextra-theme-docs": "^4.2.16",
5+
"nextra": "^4.2.17",
6+
"nextra-theme-docs": "^4.2.17",
77
"react": "^19.0.0",
88
"react-dom": "^19.0.0"
99
},

0 commit comments

Comments
 (0)