Skip to content

Latest commit

 

History

History
125 lines (75 loc) · 3.46 KB

README.md

File metadata and controls

125 lines (75 loc) · 3.46 KB
Raw

Institut des Transformations numériques

The source code of itn.dev, a web site built with Astro.

https://itn.dev

Installation

You can work on the project in the cloud (preferred method) or locally (if you know what you're doing).

0. Prerequisites

To work in the cloud, you need a GitHub account to get (a 60-hour a month free) access to GitHub Codespaces.

To work locally, you need to install:

  • Git,

  • Node.js ; we suggest that you use the latest LTS version,

1. Clone the repository

In the cloud, create a new Codespace. Alternatively, to work locally, clone the repo:

git clone [email protected]:ITN-Mines-Paris/ITN-Mines-Paris.github.io.git

2. Install Dependencies

Codespace should automatically install your dependencies. If you work locally, type:

npm install

3. Start a Web Server

The command

npm run dev

starts a Web development server. In Codespaces it will also prompt you to open a browser window (locally, you are on your own). In both cases, each time you save a file, the browser will reload the site so that you can immediately see the effect of your changes.

You are now ready to start working on the project.

4. Development cycle

  • Synchronize: download the most recent version of the project files
    (git pull locally),

  • Edit the files, then commit your changes
    (git add + git commit locally),

  • Synchronize: upload these changes to the project repository
    (git push locally).

Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
│   └── ...
├── src/
│   ├── assets/
│   │   └── ...
│   ├── components/
│   │   └── ...
│   ├── layouts/
│   │   └── ...
│   └── pages/
│       └── ...
└── package.json

Astro looks for .astro,.md or .mdx files in the src/pages/ directory. Each page is exposed as a route based on its file name.

Static assets can be placed in the public/ directory. Images placed in the assets/directory are optimized and served as static assets.

Refer to Astro documentation for more information.

Administration

Hosting

Domain Name

  • 🏢 Provider: OVH

  • 💶 Account: @boisgera

  • 🪛 Integration: @boisgera

  • 🔋 Status: ✅ Renew before 01/09/2029

Mail Service

Used in the Contact Form.