Giter Club home page Giter Club logo

pyzlnar-front's Introduction

Pyzlnar Front

Introduction

This the front end repo for pyzlnar.com
Currently the front end is running in React and Redux, written in ES6 using babel as a transpiler, and using inuit for the CSS.

This indeed sounds very fancy, but the truth is that I’m not exactly a front end guy, so chaces are that you will find stuff that is very very dirty. Hell, even the design is kinda ugly.

Installation

Requirements

You will need the following installed to be able to run the front end:

  • git
    Should go without saying. Get yourself git installed.

  • node.js v6.10.0+
    I recommend you install it via nvm.

  • yarn
    Installation instructions can be found here.

  • pyzlnar-back
    You’ll need the back end up and running to be able to get the API responses.
    Installation instructions can be found here.

Source Code

Clone the repo into your machine, and then change to the directory before you run anything else.

# Create a root directory first if you haven't already.
# The directory structure is not needed, but I like working this way.
$ mkdir pyzlnar

# Clone the repo into front
$ git clone https://github.com/pyzlnar/pyzlnar-front.git pyzlnar/front

# Change to front directory
$ cd pyzlnar/front

With the back repo, directories will look like this.

$ tree pyzlnar/ -L 1
pyzlnar/
├── back
└── front

Dependencies

Now you need to install all the dependencies. Fortunately this is done quite easily with the help of yarn.

$ yarn install

# Or if you're feeling fancy, simply
$ yarn

Running

  • Development
    Runs the server in development mode. Everything will be non obfuscated, and changes will cause an automatic reload. Default port is 8080.

# http://localhost:8080
$ yarn dev
  • Development Build
    Runs the server in a build mode for development. This emulates production, but also serves the files. JS and CSS will be compiled and obfuscated. Hot reload will also be available but it’s obviously slower. Also uses port 8080.

# http://localhost:8080
$ yarn dev:build
  • Production Build
    Builds all the assets, obfuscating them. Also copies all the images into the public folder. Since this just compiles files and expects something else to serve them (nginx) it doesn’t need a port. It takes a couple of seconds so be patient.

$ yarn build

Tests

Running the tests is very easy! You just need to do:

$ yarn test

And enjoy the nice output! Have that sense of relief that you have not killed anything.

Fair warning though, I don’t have component tests as of yet. It feels weird to test them when they’re super volatile, but maybe that’s exactly why I should. At some point I’ll probably add some minimalistic tests to ensure that at least I don’t get weird errors.

TODO

Todo

Small list of features that may be coming in the future.

  • Better responsive design

  • Better way to load static content (Eg. text)

License

Source Code

Source Code is released under the MIT License.

Images

If you believe an image infringes upon your copyright, please send an email through github with the following pieces of information:

Keep in mind we only respect requests from original artists or copyright owners, not derivative works.

  • The URL of the infringing image.

  • Proof that you own the copyright.

pyzlnar-front's People

Contributors

pyzlnar avatar

Watchers

 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.