Code Monkey home page Code Monkey logo

ok2-frontend's Introduction

ok2-frontend

This is the frontend of Open Knesset v2.0 repository. Below you will find some information about the project, how to install it locally, and the basics.

What is it about? 📢

You can read more about the general idea in this document כנסת פתוחה הדור הבא

  • The UX was made in Axure you can view it here.

  • 🌈 Design made in Figma check it out this link 🌈.

Please, feel free to add an issue if you have anything to suggest or comment on.

Project Setup

The Basics

  • JS framework: This project made with nuxt on top of Vue JS as our framework of choice. For the state management (pattern + library) Vuex was used. Make sure to pay attention to this framework and project naming convention, for example: camelCase for functions and TitleCase for Vue files.

  • Styling: A lot of effort was made on the UX/UI part of the app while trying to keep the general look-and-feel across the site. We used Vuetify UI library, so take advantage of their components and style before writing your own. Also, Vuetify and the project itself have many CSS class utility options that you can use. As a rule of thumb: 👏Write as little CSS as possible👏, none will be perfect.

  • Other technologies: TypeScript and Scss was used so that you can go ahead and benefit from their awesome features.

👩‍💻 Local development and how to launch the server

Client-side:

  1. clone or fork this repo to your machine and make sure you have nodeJs (12^) installed.
  2. npm install
  3. npm run dev

If you are using VS code for writing Javascript it will help you to add these extensions:

  • Vetur
  • ESLint (it has Beautify inside so don't install that extension or otherwise you will have conflicts)
  • Also you can add Vue.js devtools in your browser

Server-side

  1. Make sure you installed python and add it to your PATH
  2. Clone backend repository
  3. Run in the ok2-backend folder:
  • pip install -r requirements.txt (only once after pull)
  • manage.py migrate to install database (only once after pull)
  • manage.py runserver (to run localhost 8000 as)

Contribute:

We would love ❤️️ to hear from you in the issues section or by mail to one of the current contributors.

Before a pull request:

  1. Make sure the project is lint correctly and passed the type checked: npm run quality
  2. The project can be built: npm run build
  3. Ask for a code review.

OK2

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.