search

The-Shamrock / shamrockSite

0 stars 0 forks source link

readme


Logo

The Shamrock Website

A web companion to The Shamrock's digital issues
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing

About The Project

Shamrock Screen Shot

(back to top)

Built With

(back to top)

Getting Started

Environment Setup

If you've already setup your machine with Visual Studio, NVM, Yarn, etc., double check your versions and you can skip this section. If this is your first time setting up your dev machine, buckle in.

  1. Install Visual Studio Code
    • Download & follow the installation instructions here.
    • Once it is installed, be sure to install the NX Console extension
  2. Install NVM
    • For Windows, go here and click the "Download Now!" button.
    • For Mac/Linux, go here, read the docs, and install using the script.
  3. Install Node
    • From your terminal (while running as an Admin), run nvm install 20.11.1
    • Then run nvm use 20.11.1
  4. Install Yarn
    • Continuing in the terminal, run npm install -g yarn
    • Note: If you need to update your PATH variable, here's a simple gist.
  5. Install Angular
    • Continuing in the terminal, run yarn add global @angular/cli@18.2.0

Development Setup

Now that your machine is setup and environment is ready, let's get the codebase rolling.

  1. Clone the Repo
    • From the repo itself, you can click the "Code" button, and clone from there in whichever way you'd like.
  2. Setup the Site
    • Open the repo in VS Code
    • From the terminal, run yarn. This will install all packages needed.
  3. Run the Site
    • Now that the packages are restored, it's time to run.
    • Open the NX Console extension, under Projects -> shamrock-site -> serve
    • Click serve, this will start building the website. It can take up to a minute depending on your system.
    • Once this is done, the site can be accessed at localhost:4200

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

  1. Create your Branch (git checkout -b feat/AmazingFeature)
  2. Commit your Changes (git commit -m 'Add some AmazingFeature')
  3. Push to the Branch (git push origin feature/AmazingFeature)
  4. Open a Pull Request

(back to top)