Update readme to include submodules

This commit is contained in:
2025-11-06 12:24:58 +01:00
parent c97177b500
commit e10ad59029

View File

@@ -9,12 +9,15 @@ Requirements :
### Install ### Install
1. Clone or fork this repo: `git clone ssh://gitea@git.astrolabe.coop:2106/AstrolabeCAE/SiteWebAstrolabe_public.git` 1. Clone or fork this repo INCLUDING its submodule: `git clone --recurse-submodules ssh://gitea@git.astrolabe.coop:2106/AstrolabeCAE/SiteWebAstrolabe_public.git`
2. Clone or fork the private repo containing members data in the same folder that SiteWebAstrolabe_public : `git clone ssh://gitea@git.astrolabe.coop:2106/AstrolabeCAE/SiteWebAstrolabe_private.git`
3. `cd` into the project directory (SiteWebAstrolabe_public) and run `npm install` 3. `cd` into the project directory (SiteWebAstrolabe_public) and run `npm install`
4. Once all the dependencies are installed run `npm start` 4. Once all the dependencies are installed run `npm start`
5. Open your browser at `http://localhost:8080` and away you go! 5. Open your browser at `http://localhost:8080` and away you go!
If you don't have the members data (page /equipe), you may have done a simple (non-recursive) clone. In this case, populate with member data by running `git submodule update --init --recursive`. Also, check that you do have the rights for the https://git.astrolabe.coop/AstrolabeCAE/SiteWebAstrolabe_private repository.
If you need to get the latest commits of the SiteWebAstrolabe_private repo, you can do a `git submodule update --remote`.
### Deploy ### Deploy
1. Copy paste deploy.js file in two new files `deploy-preprod.js`and `deploy-prod.js` 1. Copy paste deploy.js file in two new files `deploy-preprod.js`and `deploy-prod.js`