Giter Club home page Giter Club logo

star-wars-pedia's Introduction

Star Wars-pedia

Introduction

This is a full-stack Star Wars fanclub website built with Typescript, Koa server, routing controllers, TypeORM and PostgreSQL in the backend and React with Redux in the frontend. Bootstrap is used for some of the styling and ensuring responsiveness.

Prerequisits

  • Node
  • Docker
  • Postico or a different database management tool (for example DBeaver)
  • Yarn (optional - you can also use npm to install dependencies)
  • Gulp (optional - used to compile Scss to Css)

Setting up

First clone this repository and open the code in your text editor. Then follow the steps to set up the server and the client:

Server

  1. Run postgres in a docker container (see more)

    Example:

    $ docker run -p 5432:5432 --name some-postgres -e POSTGRES_PASSWORD=secret -d postgres
    

    If you decide to connect to a different port or use different password you will need to edit the connection url in /server/src/db.ts

  2. In your terminal go to the cloned repository and then to the server directory /cd server

  3. Run yarn install to install the dependencies.

  4. Run yarn start to start the server - if everything went well in your terminal you should see:

Connected to Postgres with TypeORM
Listening on port 4000
  1. Use your database management tool to insert data in your database. Go to /server/data.txt and copy and execute all INSERT INTO commands in your SQL Query one by one. Make sure you start at the top of the file, since some tables are related to each other.

Client

  1. In your terminal go to the cloned repository and then to the client directory /cd client
  2. Run yarn install to install the dependencies.
  3. Run yarn start to start the client - the website should open on your localhost:3000
  4. If you want to make any adjustments to the /client/src/App.scss styling file you should run gulp watch in another terminal window. This will automatically compile from Scss to CSS on every save.

star-wars-pedia's People

Contributors

kristinetrona avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.