Merge pull request #5 from AmanTahiliani/alexa-frontend-getting-started

add frontend dev env setup to readme
This commit is contained in:
Aman Tahiliani
2024-04-09 16:22:55 -04:00
committed by GitHub

View File

@@ -8,3 +8,30 @@ Repository for a course project of CS4675/CS6675 at Georgia Institute of Technol
<li>Raise a PR once you are ready and have checked your code for errors.</li>
<li>Mention a bullet point summary for all the features you are pushing as part of the PR within the description to ease the review process</li>
</ul>
## Getting Started
### Frontend
For our frontend we are using React + Vite + TypeScript!
- **React** -> JavaScript Framework for creating reactive user interfaces.
- **Vite** -> Development environment / build tool. Gives us access to features like hot reload, bundling, and plugins.
- **TypeScript** -> A superset of JavaScript allowing for static types.
Here's how to set up + run the frontend environment:
1. Download and install [Node.js](https://nodejs.org/en/download) v18+
Check your node version:
```sh
node -v
```
2. Clone the repo using Git
3. Install dependencies
```sh
cd frontend
npm install
```
4. Start the development server
```sh
npm run dev
```
5. Visit http://localhost:5173