Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readme setup instructions #56

Merged
merged 1 commit into from
Nov 11, 2023
Merged

readme setup instructions #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,39 @@ On the [Projects] page, you can explore the various software projects we've been
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, 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.
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](#technologies-used), we are using [Lume](https://lume.land/docs/overview/about-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.
- If you have homebrew installed run this in your terminal:

`brew install deno`

- OR you can use the curl command:

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

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](https://docs.deno.com/runtime/manual/getting_started/installation)

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`
Loading