Create README.md #14
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,63 +1,75 @@ | ||||||
| # Devalopers Website | ||||||
|  | ||||||
|  | ||||||
|  | ||||||
|  | ||||||
|  | ||||||
|  | ||||||
|
|
||||||
| ## 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 <a name="generalinfo"></a> | ||||||
| #### 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. | ||||||
|
|
||||||
|  | ||||||
| ### Technologies <a name="technologies"></a> | ||||||
| *** | ||||||
| A list of technologies used within the project: | ||||||
| * [Technology name](https://example.com): Version 12.3 | ||||||
|
There was a problem hiding this comment. This need to be updated right
Suggested change
There was a problem hiding this comment. can you please update this section |
||||||
| * [Technology name](https://example.com): Version 2.34 | ||||||
|
There was a problem hiding this comment. this need to be updated
Suggested change
|
||||||
| * [Library name](https://example.com): Version 1234 | ||||||
|
|
||||||
| ### Prerequisites <a name="prerequisites"></a> | ||||||
| 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` | ||||||
|
|
||||||
| ### Installation <a name="installation"></a> | ||||||
| To install Devalopers Website, follow these steps: | ||||||
| ``` | ||||||
| npm install | ||||||
| ``` | ||||||
| ### Contributing to Devalopers Website <a name="contributing"></a> | ||||||
| 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. | ||||||
| <!--- If your README is long or you have some specific process or steps you want contributors to follow, consider creating a separate CONTRIBUTING.md file---> | ||||||
|
There was a problem hiding this comment. keep, we can have a different one in Devalopers repo |
||||||
| 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 <a name="contributors"></a> | ||||||
|
|
||||||
| Thanks to the following people who have contributed to this project: | ||||||
|
|
||||||
| [Contributors link](https://github.com/DevCBeirut/api.devalopers/blob/master/CONTRIBUTORS.md) | ||||||
| <!--- • How do I get started? | ||||||
| ? Devalopers API Project [Georges] | ||||||
| ? Devalopers Front End Project [Salah] ---> | ||||||
|
|
||||||
| ### Disclaimer (Important) <a name="disclaimer"></a> | ||||||
| [Must Read](https://gist.github.com/salahawad/b0aa89e54a1d2b4dd599bc49c0a7c63e) | ||||||
|
|
||||||
| ### Contact <a name="contact"></a> | ||||||
| If you want to contact me you can reach me at <salah.awad@outlook.com>. | ||||||
| ### License <a name="license"></a> | ||||||
| <!--- If you're not sure which open license to use see https://choosealicense.com/---> | ||||||
|
|
||||||
| This project uses the following license: [<https://github.com/DevCBeirut/devalopers/blob/master/LICENSE>](<link>). | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to be reverted to api