README.md

ACE Website Development Guide

Hello reader, our team has initiated this project in order to update the ACE's website and along with that this can be a great opportunity for all of the team members to learn and explore various technologies which are used on the Web.
This guide includes everything you need to get started with the Project.
Wish you luck!

If you find anything which can be improved in the README.md then ping me and give a pull request.

🚀 Quick start

1. Download required softwares.

   1. Download Github from here
   2. Download Node.js from here
   3. Download your favourite Code Editor (VS Code Preferred)

2. Setup Environment locally.

   1. Clone Repo & Install dependencies

      Linux / Mac Users

      1. Run the following commands in your terminal

      cd ~/Desktop
      git clone https://github.com/ACE-VSIT/website
      cd ./website
      yarn
      cd packages/website && touch .env.development
      cd packages/admintable && touch .env

      Windows Users

      1. Open CMD / Power Shell / Git Bash in your folder
      2. Run the following commands

      git clone https://github.com/ACE-VSIT/website
      cd ./website
      yarn
      create .env.development inside packages/website
      create .env inside packages/admintable

   2. Open the Project in your preferred code editor

   3. Opne the .env.development file of each package and add the required env-vars

   4. Start the Local Dev server

      Note* the server takes some time to start.

       yarn start

   5. Website should be up and running on your http://localhost:8000/

   6. Admintable should be up and runnning on your http://localhost:3000/

👨‍💻 Directory Structure