Skip to content

KGreenbush/Pirate_Crew

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open in Visual Studio Code

Pirate_Crew

A fun app to create the perfect pirate crew!

Give each crew mate a name, postion, quote, and decide if they should have a peg leg, hook, and/or eye patch!

The About page of each pirate shows their details and lets you "change" their looks by switching their eye patch, peg leg, or hook stats.

If you need to remove a pirate have them Walk the Plank! They're organized alphabetically so it's easy to find whom you're looking for.

And it's responsive so you can build your crew easily on any screen!

Background

This actually started as an exam for my coding bootcamp but I loved how fun it was so I wanted to keep expanding on it. The new ideas I come up with for it become new learning opportunities and learning is fun.

Visuals

Check out the images folder for more images.

Pirate Crew Add a Pirate About a Pirate Responsive Pirate layout

Prerequisites

You will need a package manager to run the installation. I used npm which comes with Node.js. And Git for cloning. And a text editor of your choice.

Postman is optional but handy for testing APIs.

Installation

Using a terminal:

    // clone the repository
    git clone https://github.com/KimGreenbush/Pirate_Crew.git

    // install dependencies
    npm install

    // navigate to the client folder and install dependencies
    cd client
    npm install

Running the app

The client and server run independently from each other so you'll need to run servers in different terminals.

    // terminal 1, start the express app where server.js is
    npm run start
    // terminal 2, start the client app
    cd client
    npm run start

Running the tests

There some snapshot tests for the client side that make sure the components render and track their changes.

    // navigate to the client side to run its tests
    cd client
    npm run test

Future

  • Registration system so users could create their own personal crew
  • File upload to replace the current dependency on urls
  • Extract client from backend app and switch to cloud services for static hosting
  • mobile compatibility

License

This project is licensed under the GNU General Public License v3.0 Free Software Foundation, Inc. - see the license.md file for details

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors