Skip to content

Commit

Permalink
update redme file
Browse files Browse the repository at this point in the history
  • Loading branch information
mdadul-solvrz committed Dec 5, 2023
1 parent c6b885e commit 0d12427
Showing 1 changed file with 3 additions and 40 deletions.
43 changes: 3 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,13 @@
SKILLIBLY API DOCUMENTATION
AUTHENTICAITON BOILERPLATE

**Table of Contents**
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Setup Environment Variables](#setup-environment-variables)
- [How to start new task:](#how-to-start-new-task)
- [IMPORTANT: Before commiting anything, make sure `husky` is working properly. Do this before commit.](#important-before-commiting-anything-make-sure-husky-is-working-properly-do-this-before-commit)
- [Auth routes:](#auth-routes)


## Getting Started
### Prerequisites
Before you start integrating the SKILLIBLY API into your project, make sure you have the following prerequisites in place:
* Node.js v10.15.3 or higher
* MongoDB v4.0.10 or higher
* NPM v6.4.1 or higher
* Git v2.17.1 or higher
* Postman v7.1.1 or higher
* VS Code v1.33.1 or higher

### Installation
To start using the SKILLIBLY API in your Express.js application, follow these steps:


1. **Clone the Repository:**
Clone the SKILLIBLY API repository from GitHub using the following command:

```bash
git clone https://github.com/Solvrz-com/skillibly-api.git
```

2. **Navigate to the Project Directory:**
Move to the cloned project directory:

```bash
cd skillibly-api
```

3. **Install Dependencies:**
1. **Install Dependencies:**
Install the required Node.js packages using npm:

```bash
npm install
```
4. **Start the Server:**
1. **Start the Server:**
```bash
npm start
```
Expand Down

0 comments on commit 0d12427

Please sign in to comment.