Skip to content

Latest commit

 

History

History
106 lines (63 loc) · 5.09 KB

README.md

File metadata and controls

106 lines (63 loc) · 5.09 KB
Raw

Stevens Blueprint Website

Blueprint

Stevens Blueprint, a student club organization dedicated to developing code for non-profit organizations.

Table of Contents

About

Stevens Blueprint is a community of passionate students at Stevens Institute of Technology who are committed to making a positive impact by developing software solutions for non-profit organizations. Our club members work on real-world projects, gaining valuable experience while giving back to the community.

Projects

On the [Projects] page, you can explore the various software projects we've been working on. Each project is aimed at helping non-profit organizations in different ways, from building websites to creating custom software tools. You can find project descriptions, status updates, and information on how you can get involved in ongoing projects or propose new ones.

Blog

Our [Blog] is where we share our experiences, insights, and updates about our work with non-profit organizations. Stay informed about the latest news, events, and project highlights by visiting this section regularly. We encourage club members to contribute to the blog and share their knowledge and experiences.

Technologies Used

Our website is built using Lume, a static site generator (SSG), which provides a simple and efficient way to create static websites. The use of Lume ensures that our website is fast, reliable, and easy to maintain. You can find the website's source code and more information about how it's built in our GitHub repository.

Contributors

Thank you for wishing to contribute to our Chapter's Website! As stated above, we are using Lume for this site. Lume is an SSG that uses Deno, a runtime for Javascript. If you are familiar with git, feel free to follow the installation, clone, and running steps. If you are unfamiliar that's good too; the instructions will be a little more verbose so you can easily follow along. We assume you have already installed git 👍

Setup for contributors

  1. Ensure that you have Deno installed. You can skip this step if you do. If you don't or are unsure, you can use the following command to install it.

    Homebrew users:

    brew install deno

    Linux/Non-Homebrew Users:

    Run the following in your terminal:

    curl -fsSL https://deno.land/x/install/install.sh | sh

    If you are using bash run code $HOME/.bashrc to open your bash configuration file in VSCode.

    If you are using zsh run code $HOME/.zshrc to open your zsh configuration file in VSCode.

    In your respective file add the following:

    export DENO_INSTALL="/home/REPLACE_WITH_YOUR_USER/.deno"
export PATH="$DENO_INSTALL/bin:$PATH"

    Re-run the curl command.

    Restart your terminal or enter a new one. To confirm deno was installed, check the version by running deno --version, should see something like deno 1.37.2

    You can find more information on the Deno Docs

  2. We need to clone the repository, which can be done with the following command:

    • For beginners, we recommend having a folder on your computer where you plan on having this repo be stored.

      1. To do such, open your Finder or File Explorer alongside a blank new VSCode window.
      2. Drag the folder (that you wish to have this repository put into) inside of the VSCode window OR do File > Open Folder in VSCode.
      3. Now, inside VSCode open the terminal (In the Top Menu Bar press 'View' > 'Terminal'). You can now run the below command.

    • cloning via https:

      git clone https://github.com/stevensblueprint/blueprint_website.git

  3. We can run the project using the following command:

    deno task serve

  4. You did it! You should see the project running on http://localhost:3000

  5. After editing the code, run prettier write in the terminal to make the code formatted correctly.

npm run format:write

Note: make sure npm is installed on your machine

For Project Teams Updating their Project Page

The content of the project description is all contained within a markdown file

To update the content:

  • Create a branch called projectUpdate/{REPLACE_WITH_PROJECT_NAME}
  • In your branch, access your project's respective markdown file in src/projects and make your respective edits
  • Submit a pull request for review

To add a new project:

  • Create a branch called newProject/{REPLACE_WITH_PROJECT_NAME}
  • In src/projects create a new markdown file with the non-profit's name. Make the file name all lowercase and use hyphens "-" instead of spaces or underscores
  • Add the following fields to your project: (title, layout, url, project_title, project_logo_url, github_repository_url)
  • Fill in the above fields (refer to current projects for help)