diff --git a/.github/workflows/pages-deploy.yml b/.github/workflows/pages-deploy.yml index dd1c9e2..09cb355 100644 --- a/.github/workflows/pages-deploy.yml +++ b/.github/workflows/pages-deploy.yml @@ -31,7 +31,7 @@ jobs: - name: Set up Node uses: actions/setup-node@v4 with: - node-version: 23 + node-version-file: .nvmrc cache: "npm" - name: Install dependencies run: npm ci diff --git a/.node-version b/.node-version new file mode 100644 index 0000000..dd6db9f --- /dev/null +++ b/.node-version @@ -0,0 +1 @@ +23.5.0 \ No newline at end of file diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..dd6db9f --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +23.5.0 \ No newline at end of file diff --git a/README.md b/README.md index ecee869..669b885 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ # Code Café Community website :construction: Currently under construction :construction: + +## Prerequisites for Contributing + +This project requires the following: + +- Node version `23.5.0` + +### Setting Up Node.js Version + +To ensure compatibility, please use [nvm](https://github.com/nvm-sh/nvm) or a similar tool to manage Node versions. + +#### Using nvm + +1. Install nvm if you don’t already have it: https://github.com/nvm-sh/nvm#installing-and-updating. +2. Run the following command in the project directory: + ```bash + nvm use + ``` + +If you don’t have Node.js 23.5.0 installed, nvm will prompt you to install it. + +run: + +```bash +nvm use 23.5.0 +``` + +### Install Dependencies + +Once the correct Node.js version is set up, install the project's dependencies: + +```bash +npm install +``` + +### Start the Development Server + +```bash +npm run dev +```