Code Monkey home page Code Monkey logo

main's Introduction

main

This is the repo where we bring all the modules together into one app.

Check out what we are about here:

https://getcouragenow.org/

Developer setup

You need to make sure you have all the dependencies setup first.

The bootstrap repo is for boot strapping your laptop.

Run the examples using the Makefile to ensure you have an environment that works.

Working on an issue

The Kan Ban should be looked at to work out what to work on.

Is you want to work on an issue, please first ensure that you understand the issue and the suggested approach.

When you take an issue, please assign yourself to it and let everyone know on the Telegram group called "winwisely-dev", so we everyone knows your taking it.

Builds

Use the Makefiles and keep them working.

If you followed the Developer setup these make files will work on Windows, Mac and Linux.

If they do not work for you then raise an issue so that the bootstrap or Makefile can be fixed for everyone benefit.

CI and CD

There is no CI / CD yet, but soon there will be.

For now just upload them here: https://drive.google.com/drive/folders/11R71oZGZiHWoYmex7jeSowZFcDxvxX5i

Code generation

We make heavy use of code generation.

The grpc - protobuf parts of both client and server are heavy inspired by https://github.com/amsokol/flutter-grpc-tutorial

Docs

Functional Documentation for each module are here: https://drive.google.com/drive/folders/1F2orl3P46MwAct9kyWSO8550Wn2es8RH

Its worth reading this to get an idea of what the system is intended to do.

Plugins

This project is designed to run on Web, Desktops and Mobiles using Flutter.

This means that plugins must work on all clients and so when choosing a plugin be careful to avoid breaking things.

All plugins that use native code should live here. https://github.com/winwisely99/plugins

We try to avoid native plugins in general.

FAQ

If your curious about why this project exists or how to get involved, please see the following the FAQ

UAT ( User Acceptance Testing )

For those helping to test the apps please follow the UAT Guidelines

Pair Programming

For those using VSCode this is an excellent way to code together: https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare-pack

Contributing

Please follow the Contributing Guidelines

Code of Conduct

This project adheres to the Contributor Covenant code of conduct.

Please see the following the Code of Conduct Guidelines

By participating, you are expected to uphold this code.


Please report unacceptable behavior to [email protected]

License

This project is open source software licensed under the Apache LICENSE.

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.