Veronaut Products API

About the project

Veronaut was created in 2020 as the capstone project for my Bloc (now Thinkful) Full-Stack Engineering bootcamp. The requirements for my capstone project were to create a responsive, full-stack app using React.js, CSS, Node.js, Express, and PostgreSQL. This was a solo project which I completed with occasional help from a mentor.

The early vision of this app resulted from my professional background. Before I joined a software engineering bootcamp, I earned a biology degree with a focus on environmental conservation and additional studies in economics, conducted research of smallholder cotton farms in Peru, and founded a mission-based clothing brand, Silvania. My background in the fashion industry, as well as my personal experience shopping for clothes, has led me to see that finding sustainably-made clothing as a consumer is unnecessarily cumbersome.

(back to top)

Built with

(back to top)

Getting started

To get a local copy of Veronaut Products API up and running follow these steps.

Prerequisites

Install or update Node.js and npm to the latest versions. For information about current versions of Node.js and npm, see the Node release schedule.

• To see if you already have Node.js and npm installed and check your installed versions, run the following command:

  node -v && npm -v

• Install or update Node.js if needed at Node.js Downloads. The Node.js installer automatically installs or updates npm as well.
• If your version of Node.js is current, but npm needs to be updated, install the most recent stable version of npm by running the following command:

  npm install npm@latest -g

Installation

1. In the command line, navigate to the directory where you would like to copy Veronaut Products API.
2. Clone the veronaut-products-api repository.

   git clone https://github.com/georgiakirkpatrick/veronaut-products-api.git

3. Navigate to the veronaut-products-api directory and install the project's npm packages.

   cd veronaut-products-api && npm install

(back to top)

Contributing

Veronaut Products API is an open souce project. Any contributions you make to this project are greatly appreciated.

If you have a suggestion about how to make Veronaut Products API better, please open an issue with the tag "enhancement". You can also fork the repo and create a pull request by following the steps below.

Don't forget to give this project a star! Thank you!

Fork the repository

Some of the instructions below use GitHub command line interface (CLI). You may learn more about GitHub CLI and install at "GitHub CLI quickstart".

1. Fork the project and configure Git to sync your fork with the upstream repository. When prompted, type "y" and "return" (or "enter") to clone the veronaut-products-api files to your computer.

   gh repo fork https://github.com/georgiakirkpatrick/veronaut-products-api --remote=true

2. Navigate into the veronaut-products-api directory.

   cd veronaut-products-api

3. Create a new branch to build your proposed feature and switch to your new branch. Replace "new_feature" with the name of your feature.

   git checkout -b feature/new_feature

4. Build your new feature.

5. Commit your changes. Replace "commit_message" with an informative description of your changes.

   git commit -m 'commit_message'

6. Push to your branch. Again, replace "new_feature" with the name of your feature.

   git push origin feature/new_feature

7. Open a pull request. Consider using pull request flags described in "Creating a pull request".

   gh pr create

(back to top)

Contact

The best way to get in touch with me is to use the contact form on my website: georgiakirkpatrick.com/#contact.

You can also connect with me on LinkedIn: Georgia's LinkedIn.

Acknowledgments

• This project started during my Software Engineering course at Thinkful, now owned by Chegg Skills. Alvaro P. was my mentor who guided me on the project and got me unstuck once a week while I was in the program.

(back to top)