From 4af22296db97238d5a83c6d018ba5bfe1e79cd93 Mon Sep 17 00:00:00 2001 From: Mirna Itani <85676442+mirnaitani6@users.noreply.github.com> Date: Wed, 16 Jun 2021 07:54:04 +0300 Subject: [PATCH] Create README.md --- README.md | 90 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 51 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 70c2d92..4939014 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,75 @@ -# Devalopers Backend - -![GitHub repo size](https://img.shields.io/github/repo-size/DevCBeirut/api.devalopers) -![GitHub contributors](https://img.shields.io/github/contributors/DevCBeirut/api.devalopers) -![GitHub stars](https://img.shields.io/github/stars/DevCBeirut/api.devalopers?style=social) -![GitHub forks](https://img.shields.io/github/forks/DevCBeirut/api.devalopers?style=social) +# Devalopers Website +![GitHub repo size](https://img.shields.io/github/repo-size/DevCBeirut/devalopers) +![GitHub contributors](https://img.shields.io/github/contributors/DevCBeirut/devalopers) +![GitHub stars](https://img.shields.io/github/stars/DevCBeirut/devalopers?style=social) +![GitHub forks](https://img.shields.io/github/forks/DevCBeirut/devalopers?style=social) ![Twitter Follow](https://img.shields.io/twitter/follow/salahelawad?style=social) -![GitHub issues](https://img.shields.io/github/issues/DevCBeirut/api.devalopers) - - -Devalopers is an `online platform (backend here) ` that allows `Tech Companies in Globally and especially in MENA ` to post `jobs and projects` while `Developers, UX/Graphic designers, AI/ML, Tech Project managers and Tech product managers` to find `Remote Jobs and Freelancing projects`. - -This repository will create a `free` platform to post jobs and apply for jobs for all its users - -## Disclaimer (Important) -[Must Read](https://gist.github.com/salahawad/b0aa89e54a1d2b4dd599bc49c0a7c63e) - -## Prerequisites +![GitHub issues](https://img.shields.io/github/issues/DevCBeirut/devalopers) + +## Table of Contents +1. [General Info](#generalinfo) +2. [Technologies](#technologies) +3. [Prerequisites](#prerequisites) +4. [Installation](#installation) +5. [Contributing to Devalopers Website](#contributing) +6. [Contributors](#contributors) +7. [Disclaimer](#disclaimer) +8. [Contact](#contact) +9. [License](#license) +### General Info +#### What is the Devalopers? #### +- [Devalopers](https://devalopers.com/) is a business-oriented website that provide opportunities for Tech Talents to accomplish the digital needs of all sizes business across the world based on their skills +- The project is built as a monolithic NodeJS application serving a ReactJS web application. +#### What does Devalopers do? #### +- Allows Tech Companies Globally and especially in MENA to post jobs and projects while Developers, UX/Graphic designers,AI/ML, Tech Project managers and Tech product managers find Remote Jobs and Freelancing projects +- Match Tech Talents with a requested opportunity based on their skills listed in their profile and vice versa +#### Why is this Devalopers useful? #### +- In a job-seeker’s perspective, the purpose of “Devalopers” is to open the door of opportunities, untraditionally, by matching each user’s skills with job’s required skills. +- In a company’s perspective, “Devalopers” will help to place the right professional employee who fits the job’s requirements and exact skills. + +![Image text](https://devalopers.com/static/media/map-banner.561a61b8.png) +### Technologies +*** +A list of technologies used within the project: +* [Technology name](https://example.com): Version 12.3 +* [Technology name](https://example.com): Version 2.34 +* [Library name](https://example.com): Version 1234 +### Prerequisites Make sure you have installed all of the following prerequisites on your development machine: * Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed. * Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager. * MongoDB - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017). * Copy `.env.example` and rename it to `.env` - -## Installing Devalopers Backend - -To install Devalopers Backend, follow these steps: +### Installation +To install Devalopers Website, follow these steps: ``` npm install ``` -## Using Devalopers Backend - -To use Devalopers Backend locally, execute the following steps: - -``` -npm start -``` - - - -## Contributing to Devalopers Backend +### Contributing to Devalopers Website +Contributing to this open-source project can be a rewarding way to learn, teach, and build experience about any targeted skill you want to build and not only in term of development. -To contribute to Devalopers Backend, follow the steps described in this file: +To contribute to Devalopers Website, follow the steps described in this file: [Contributing link](https://github.com/DevCBeirut/api.devalopers/blob/master/CONTRIBUTING.md) Alternatively, see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). -## Contributors +### Contributors Thanks to the following people who have contributed to this project: -[Contributors link](https://github.com/DevCBeirut/api.devalopers/blob/master/CONTRIBUTING.md) +[Contributors link](https://github.com/DevCBeirut/api.devalopers/blob/master/CONTRIBUTORS.md) + -## Contact +### Disclaimer (Important) +[Must Read](https://gist.github.com/salahawad/b0aa89e54a1d2b4dd599bc49c0a7c63e) +### Contact If you want to contact me you can reach me at . - -## License +### License -This project uses the following license: [](). \ No newline at end of file +This project uses the following license: []().