Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaelbrusegard/niclasnordlundphotography
A photography website for freelance photographer Niclas Nordlund.
https://github.com/michaelbrusegard/niclasnordlundphotography
expressjs gcp-app-engine gcp-cloud-functions gcp-domains gcp-storage-bucket nodejs stripe-checkout website
Last synced: 7 days ago
JSON representation
A photography website for freelance photographer Niclas Nordlund.
- Host: GitHub
- URL: https://github.com/michaelbrusegard/niclasnordlundphotography
- Owner: michaelbrusegard
- License: apache-2.0
- Created: 2022-09-07T11:49:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-05T10:34:55.000Z (6 months ago)
- Last Synced: 2024-05-05T11:32:00.744Z (6 months ago)
- Topics: expressjs, gcp-app-engine, gcp-cloud-functions, gcp-domains, gcp-storage-bucket, nodejs, stripe-checkout, website
- Language: HTML
- Homepage: https://www.niclasnordlund.com
- Size: 372 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Niclas Nordlund Photography
Live: [niclasnordlund.com](https://niclasnordlund.com)
This is the source code to Niclas Nordlund's photography website. The website showcases his photos and provides a way for potential clients to contact him. It also has a shop to sell digital copies of his photos. The website is built with HTML, CSS, and JavaScript and deployed on Google Cloud Platform. It uses App Engine to host the website + the admin panel and cloud storage buckets + cloud functions for handling photos and other assets. It is responsive and works with keyboard navigation. Purchases are handled using Stripe, and there is also a bug reporting site for users ([www.niclasnordlund.com/bug](https://www.niclasnordlund.com/bug)) that implements with GitHub issues.
## Table of Contents
- [Project Structure](#project-structure)
- [How everything works together](#how-everything-works-together)
- [How to run](#how-to-run)
- [Screenshots](#screenshots)
- [Home](#home)
- [Showcase](#showcase)
- [Shop](#shop)
- [Admin](#admin)
- [What I have Learned](#what-i-have-learned)
- [Credits](#credits)
- [Contributing](#contributing)
- [License](#license)
## Project Structure
The project is structured as follows:
- `website/` - This is the main website code built with express.js. It is hosted on Google App Engine.
- `public/` - Frontend code for the website.
- `img/` - Static images and icons.
- `css/` - CSS files.
- `scripts/` - JavaScript files.
- `admin/` - This is the admin panel code built with express.js. It is hosted on Google App Engine.
- `views/` - HTML files for the admin panel.
- `functions/` - These are functions modifying photos through Google Cloud Storage Buckets. They are hosted on Google Cloud Functions.
- `compressPublicPhotos` - Compresses the original photos and stores them in a public bucket.
- `deletePublicPhotos` - Deletes photos from the public bucket when they are deleted from the bucket with the original photos.
- `archivePurchasedPhotos` - Archives purchased photos and stores them in a bucket temporarely and returns a signed URL to the backend.
#### How everything works together
The website works by interacting with public storage buckets and displaying the photos in them. Niclas can upload, delete and download the photos through the admin panel. Every single showcase site on the website has it's own public storage bucket. The carousel on the home page is also loaded from it's own editable public storage bucket. The shop displays photos from it's own public storage bucket that is mirroring a private bucket with the original photos. The cloud functions compressPublicPhotos and deletePublicPhotos are responsible for keeping these buckets in sync with lower quality compressed photos displayed from the public bucket. Everything Niclas has to do is upload the full quality photos he wants to sell through the admin panel with the price embedded in the name, and the cloud functions will take care of the rest. The website reads the price from the photos in the public bucket and displays them in the shop. When a user purchases a photo, the cloud function archivePurchasedPhotos is triggered it will archive the purchased photos from the private bucket with the original photos to another private bucket where the archive is stored temporarely and a signed URL is returned to the backend. The backend then sends the signed URL in an email to the user. The archive is then deleted after a set amount of time.
## How to run
I would not recommend for anybody to use this code for their own website. It is very specific to Niclas Nordlund's needs and would require a lot of work to make it work for anybody else. Also I won't be providing any support for anybody trying to replicate this website. The reason I keep this open source is to showcase my work and to provide inspiration for others. For me this project has been a great learning experience and I hope it can be for others as well. There are many better ways to setup a project like this and I would recommend looking into those instead of trying to replicate this project. See [What I have Learned](#what-i-have-learned). If you still want to try to run this project, here is how:
1. Clone the repository.
2. Install dependencies with `npm install`.
3. Create a `.env` file in the root directory with the variables found in `.env.sample`. When deploying to Google Cloud Platform, these variables are set in the environment variables. I am using GitHub Actions to deploy the website with GitHub Secrets as the environment variables. See `.github/workflows/deploy.yml` for more information.
4. You then need to set the correct permissions in the Google Cloud IAM. The archivePurchasedPhotos cloud functions needs the Service Account Token Creator role to be able to create signed URLs. The deployment service account needs the App Engine Admin role to be able to deploy the website and the admin panel, the Cloud Build Service Account and the Cloud Functions Developer role to be able to deploy the cloud functions, the Service Account User role to be able to impersonate the service account for the cloud functions, the Storage Object User and Storage Object Viewer roles to be able to read and write to the storage buckets. The default App Engine service account needs the Service Account Token Creator role to be able to create signed URLs in the Admin Panel.
5. To run the website or the admin panel locally, navigate to the project folder and execute `npm run dev`. You also need to setup a service account for local development and load in it's credentials using the `GOOGLE_APPLICATION_CREDENTIALS` environment variable. This service account needs these roles: Cloud Functions Developer, Cloud Functions Invoker, Storage Object User and Storage Object Viewer.
6. When I am running the website locally, I am still using the same storage buckets and cloud functions as the live website. This is because I don't want to have to upload the photos twice, and I don't think I would have to modify the cloud functions code often. This is not ideal, but it works for me. If you want to run the website locally with your own storage buckets, you need to change the bucket names in the environment variables. To use seperate cloud functions for local development you can deploy different cloud functions and link them to your seperate storage buckets.
7. To test with stripe locally for the main website you need to have the Stripe CLI, you can then run `npm run stripe` to recieve webhook requests locally and `npm run buy` to test a sucessful purchase. You need to modify the `npm run buy` script to reference your own photos.
8. It is also advisable to have the Google Cloud SDK installed to be able to deploy or modify roles and permissions using the command line.
## Screenshots
### Home
### Showcase
### Shop
### Admin
## What I have Learned
1. **There is a reason why JavaScript Frameworks exist.**
- When starting this project it was part of a university course teaching basic web technologies with HTML, CSS and JavaScript. We were not allowed to use any frameworks and the website was meant to be a very simple static website. After that this project evolved into something completely different and a lot of headaches and time spent on this project could have been spared if I had used a framework. I would recommend using a framework for any project that is not a very simple static website. On the other side, I have learned a lot about how the web works and how to build a website from scratch.
2. **Databases are great and I should have used one.**
- I have learned that databases are great and that I should have used one for this project. It would simplify a lot of the logic to have a database entry for each shop item that references the price, the compressed photo and the original photo. It would also make it easier to add more information to each shop item. For instance adding keywords for a search function.
3. **I should have used less Storage Buckets.**
- Using a seperate storage bucket for every page is very unneccesary. It creates a bunch of environment variables that needs to be set and it makes it harder to add new pages. It would have been just as simple to use a single storage bucket for the showcase pages that has a directory structure referencing the different pages.
4. **Security is very interesting.**
- Setting up a secure website with user authentication and authorization for the admin panel has been very fun. I have learned a lot about how to secure a website and how to handle user authentication and authorization. I used sessions and cookies to authenticate Niclas and I used a middleware to authorize. I had to use CSRF tokens to prevent CSRF attacks. For the next project I will look into having multiple users and token based authentication.
5. **Using Google Cloud Platform was overkill.**
- Google Cloud Platform is great and I have learned a lot about it, but it was overkill for this project. I could have used a much simpler solution like Firebase, Heroku or simply self hosting. I'm looking into using Firebase in the future!
6. **I should have used tailwind CSS.**
- We were forced to use plain CSS because of the course requirements, but I would have used a CSS framework like tailwind CSS if I could. I have learnt tailwind CSS and I think it is great, it saves so much time and makes everything easier to read and understand.
## Credits
This project uses a combination of various technologies and services. I would like to express my gratitude to the following:
1. **Node.js**: The runtime environment that enables server-side JavaScript execution, serving as the foundation for this project.
2. **Express.js**: A fast and minimal web application framework for Node.js, which forms the backbone of this project.
3. **Stripe**: A payment processing platform that enables secure and seamless transactions on our website, providing a trusted payment gateway for our users.
4. **Google Cloud Platform**: The cloud computing and hosting infrastructure that powers this project, including Google App Engine for hosting, Cloud Storage for managing assets, and Cloud Functions for executing serverless code.
5. **GitHub**: The version control platform where this project is hosted and collaborated on, enabling efficient code management and collaboration with the open-source community.
6. **express-rate-limit**: A middleware for rate limiting HTTP requests in Express, enhancing the security and performance of our web application.
7. **express-session**: A middleware for managing user sessions in Express, helping us create a secure and stateful experience for our users.
8. **bcrypt**: A library for securely hashing passwords, ensuring the confidentiality of user credentials.
9. **crypto**: The built-in Node.js crypto module used for various cryptographic operations within the project.
10. **multer**: A middleware for handling file uploads in Express, simplifying the process of managing and processing user-uploaded files.
11. **gae-app-yaml-replace-env-variables**: A utility library for Google App Engine's `app.yaml` files, enabling the replacement of environment variables during deployment.
## Contributing
Any contributions are welcome. If you want to fix any issues or add any features, please create a pull request and I will review it. Thank you!
## License
This project is licensed under the [Apache License 2.0](LICENSE).