Skip to content

Latest commit

 

History

History
62 lines (51 loc) · 3.67 KB

README.md

File metadata and controls

62 lines (51 loc) · 3.67 KB
Raw

A Star Wars Project

A Star Wars 🌌🔫 project beautifully developed using SWAPI API.

Links

Frontend

  • Stack - ReactJS and Material UI

Backend

  • Stack - NodeJS and ExpressJS

Important

To connect frontend with backend and to run both of them on local machine, replace the base url in this file on line number 10 with http://localhost:5000.

Prerequisites 🚀

To have a local copy of this website up and running on your local machine, you will first need to install the following software/libraries/plugins:

  • Node - Download and install Node, which also includes NPM (Node Package Manager). This will allow you to run both the frontend and backend.
  • Visual Studio Code - Download and install VS Code or any Editor/IDE(Integrated Development Environment) of your choice.

Installations 📙

Steps on how to get this development env running. We'll use Node and NPM.

  • Head to the official Node website to download and install Node, which also includes NPM.
  • Select the Recommended For Most Users button and download the current version for your Operating System.
  • After you download and install Node, open command prompt/terminal and run the following commands to check if everything works:
    • node -v
    • npm -v
  • To run this project, clone it on your local machine and go to the directories (i.e., client and server) where the project is installed using cd ../folder_name/client and cd ../folder_name/server. Open both the folders side-by-side in CMD or in Visual Studio Code Terminal.
  • Run npm install to install all the dependencies used by this project.
  • Finally, run npm start to see it on the localhost.

Built With 🧰

Libraries Used ✨

Available Scripts 📜

npm start

Runs the app in the development mode. Open http://localhost:3000 to view the client and http://localhost:5000 to view the server in the browser. The page will reload if you make edits. You will also see any lint errors in the console.