Giter VIP home page Giter VIP logo

zc_main's Introduction

zc_main

This is the Zuri Chat frontend built with ExpressJS (Backend) and React (Frontend)

Getting Started.

Make sure you have nodejs installed by running the following command:

node -v

If the output is not the version of your nodejs installation, install nodejs from here

After installing nodejs install yarn if you don't have it then install the project's dependencies:

yarn zcmain:install

STARTING THE SERVER

Backend

yarn backend:serve

Open http://localhost:5000 with your browser to see the result.

Frontend

yarn frontend:serve

Open http://localhost:3000 with your browser to see the result.

RUNNING YARN COMMANDS

Backend

yarn backend <command>

for example

yarn backend add is-odd

Frontend

yarn frontend <command>

for example

yarn frontend add is-odd

root & spa

root

cd root && yarn install && yarn dev

spa

cd spa && yarn install && yarn dev

Editor setup

We're using eslint for linting and prettier for code formating, make sure you install eslint and prettier plugins in your editor so you can see linting errors as you code and have your code formatted on save by prettier. If formatOnSave doesn't work please google how to set up format on save for the eslint & prettier plugins in your editor ๐Ÿ™ƒ

Project structure

  • All components are in the components folder and styles for those components are in the styles folder.
  • Assets are in the assets folder, including images

Contributing

For detailed information on how to go about contribution. Check out the Contribution Guide

Before send PR or making a merge make sure you code is properly formatted. You can easily do that by running

yarn format # in project directory

zc_main's People

Contributors

a11rew avatar abaniwom avatar agkayster avatar ayodejioladimeji avatar bwise1 avatar chumex412 avatar cyrilchukwuebuka avatar dantanee avatar eltana avatar falence avatar funabab avatar heisdeku avatar ickynavigator avatar kene10-codes avatar khrees2412 avatar mwafrika avatar obafemiolorungbon avatar obediobadiah avatar oseunabiola avatar pidoxy avatar sammiearchie77 avatar solintin avatar tech-sis avatar temilade05 avatar thatdeji avatar theisrael1 avatar tuasegun avatar walemust avatar wumidev avatar zyhon96 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.