Link to backend documentation https://github.com/labseu2-niyon/backend/blob/master/README.md
You can find the deployed project at https://niyonapp.com/
Check our about page at https://niyonapp.com/about
[Trello Board] https://trello.com/b/fvJgJWWA/niyon
[Product Canvas] https://www.notion.so/Niyon-c215b4850eaf4cc39162e9c455993155
[UX Design files] https://whimsical.com/51S63ddNuAZB5d7azZ9L9d
Find a mentor. Niyon is a platform for connecting young professionals with mentors in West Africa. We connect you with mentors who are located in the same city, town or local government area you are in.
- Create your account or login with your social account
- Connect with mentors and mentees
- Chat with them
- A popular library, many modules are available, as is plenty of up-to-date information about it.
- Performance - ReactJS its using a virtual DOM that provides superior performance
- Reusable Components - React provides a component based structure. You can re-use components anywhere you need. As a result, (1) your app has consistent look and feel, (2) code re-use makes it easier to maintain and grow your codebase, and (3) it is easier to develop your app.
- Native Approach: React can be use to create mobile application( react native) .React code its really reusable. So at the same time someone can make IOS , Android application
Handles routing (replaces React Router), clear separation between pages and components. Client-side rendered which makes loading faster.
Hooks makes it easier to update state, there's also no need for class components or lifecycle methods like componentDidMount.
Provides one source of truth for state, easier to manage the application state if working in a group.
Our team has extensive experience in ReactJS and NextJS was chosen over React because of the server side rendering and integrated tooling/router.
Hooks enable us to manage our state such as (form handling, dropdown menu etc) in a functional components.
Redux provides us with the ability to manage our state in a central store that can be accessed by all components.
Can have reusable components (easier to have a style guide), easier to organize than other CSS in JS methods (e.g. components can be kept in one file or sorted by type) :
- scoped styles
- normal CSS syntax
- props based conditional style
- create reusable style
- native mobile support - for teams with a React codebase who also use React Native for mobile development, styled-components is one of the best-unified solution out there
Passport JS is authentication middleware for Node.js. Extremely flexible and modular, Passport can be unobtrusively dropped into any Express-based web application. It has a social authentication feature that helps with authenticating users via their social handles like facebook, twitter, etc by interacting with these social handle API. It is compatible to use, free, flexible and secured.
For users registering directly to our platform, we will use JSON Web Token.
PassportJS allows us to integrate a lot of different auth providers (facebook, etc.) and also enables us to integrate OAuth (all different versions).
Socket.io is a chat framework that performs real-time chat analytics and is compatible across all platforms (web, mobile) and devices.
We choose socket.io over Pusher because it gives us more flexibility, isn't a third party service (limited plan available for free).
Moreover, socket.io have the following 3 unique features:
- Real-time analytics - Push data to clients that gets represented as real-time counters, charts or logs.
- Binary streaming - Starting in 1.0, it's possible to send any blob back and forth: image, audio, video.
- Instant messaging and chat - Socket.IO's "Hello world" is a chat app in just a few lines of code.
[Formik] takes care of the repetitive tasks, keeping track of values/errors/visited fields, orchestrating validation, and handling submission. It uses just plain React state and props. By staying within the core React framework, Formik makes debugging, testing, and reasoning about your forms a breeze.
Heroku is a platform as a service for Amazon Web Services. Heroku makes it easy to set up an AWS deployment by handling most of the set up. This is ideal for development and staging as we can test projects without having to worry about too much set up.
Continuous integration is crucial in modern web development as it ensures all automated tests pass before merging branches and deploying. This ensures bugs are caught at the earliest possible stage.
ZEIT Now is a really simple and scalable way to deploy your application. Pages are deployed as server-less functions meaning billing only occurs in 100ms increments when the site is actually being used. Also as we are using Next.js, also a Zeit product, this allows a seem-less deployment process with two products designed to work together.
| Image Filename | Source / Creator | License |
|---|---|---|
| mentor.png | Freepik | Flat Icon |
| student.png | Freepik | Flat Icon |
- Install packages with
yarn install - Run the server locally with
yarn dev
"scripts": {
"dev": "next -p 3001",
"build": "next build", - creates a build of the application
"start": "next start", - starts the production server after a build is created
"test": "jest --watch --verbose", - runs tests
"husky-test": "jest",
"circle-ci-test": "jest",
"lint": "./node_modules/.bin/eslint . --fix",
"deploy:staging": "now -A staging.now.json --target production",
"deploy:production": "now -A production.now.json --target production"
},
It's also possible to use the Now CLI. More information.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
If you are having an issue with the existing project code, please submit a bug report under the following guidelines:
- Check first to see if your issue has already been reported.
- Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
- Create a live example of the problem.
- Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.
We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.
If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.
Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
- Ensure that your code conforms to our existing code conventions and test coverage.
- Include the relevant issue number, if applicable.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
These contribution guidelines have been adapted from this good-Contributing.md-template.