Getting Started
info
The TCET Training and Placment page is built using AstroJS, an all-in-one web framework designed for speed.
Steps to run the site on your local system:
These are the steps you need to follow to get this site on your local system.
Install Git in your computer
Follow these steps to install git in your computer.
- Go to https://git-scm.com/downloads.
- Click on Windows. Download should start.
- Go to downloads and install the package.
Clone the repo
Open Git Bash in any folder and paste the following command
git clone https://github.com/tcet-opensource/tnp-website
Install NodeJS
- Go to https://nodejs.org/en/download
- Select Current.
- Download the 64-bit .msi version. Follow the steps and install NodeJS.
note
It is important to have NodeJS in your system
Open the folder in VS Code
- Install VS Code if not installed.
- Open Windows Terminal in the folder you have cloned the repo, as done in step 2.
Install Important Packages/Dependencies
Install yarn globally
npm install -g yarn
You can make changes to your respective files and changes will be shown once you have saved the file.
Commands used to run locally
- To run the commands, make sure that you have installed yarn globally first.
- All commands are run from the root of the project, from a terminal
Here are a set of commands used to run locally:
Command | Action |
---|---|
yarn | Installs dependencies |
yarn dev | Starts local dev server at localhost:3000 |
yarn build | Build your production site to ./dist/ |
yarn preview | Preview your build locally, before deploying |
yarn astro ... | Run CLI commands like astro add , astro check |
yarn astro --help | Get help using the Astro CLI |
Steps to run after a Pull / Merge:
- To install all dependencies
yarn
- To run local dev environment
yarn dev