Ecosyste.ms: Awesome

Squirrel is an oracle powered bootstrapped node Website. It is a faithful copy of Rokomari.com. You'll find many features that is in the main site. We tried best of our ability to create something in this short time.

Youtube Demo: https://youtu.be/eeUI5hNmdYo

## ERD

![](https://raw.githubusercontent.com/TamimEhsan/SQuirreL/master/Assets/erd.png)

## Built With :heart: and

- Nodejs
- EJS
- Bootstrap
- OracleDB

(back to top)

## Getting Started

Follow the step by step installation procedure to install and run this on your machine

### Prerequisites

Make sure you have node and oracle installed in your device.

**`NodeJs`**: Install Nodejs from [here](https://nodejs.org/en/download/)

**`Oracle`**:Install Oracle from [here](http://www.oracle.com/index.html) and register for an account of your own

### Installation

#### Getting the repository

1. Clone the repo
```sh
git clone https://github.com/TamimEhsan/SQuirreL.git
```

2. If you don't have git installed in your device then download zip

3. After installation or download go to the repository and open command line.

4. Install NPM packages

```sh
npm install
```

#### Setting up the database

1. Go to sql plus

2. Enter credentials

```sh
username: sys as sysdba
password: password
```

3. Create a new user c##squirrel

```sh
create user c##squirrel identified by password;
grant dba to c##squirrel;
```

4. Find file dump.sql in `sql/SQL_DUMP.sql`

5. Head over to your favourite database GUI and connect squirrel with that

6. Import data from sql file depending upon the GUI.

7. The DUMP should work i hope 😩

8. If no errors are shown we are good to go!

#### Setting up the environment variables

create a new file `.env` in the root directory. And the file should have the followings

```sh
DB_USER= YOUR_DB_USER
DB_PASS= YOUR_DB_PASS
DB_CONNECTSTRING=localhost/orcl
PORT=YOUR_FABOURITE_PORT
APP_SECRET=YOUR_DARKEST_SECRET
```

If you followed the above then the `.env` should look like this

```sh
DB_USER= c##squirrel
DB_PASS= password
DB_CONNECTSTRING=localhost/orcl
PORT= 3000
APP_SECRET=iLoveSquirrel
```

#### Getting the big static data

We are almost done. As there are size restrictions of files, we couldn't upload the images in github 😪. So go to :arrow_forward: [drive](https://drive.google.com/file/d/1P9d5But_VUcviEykeNlIUvejf0JQnAQY/view?usp=sharing) :arrow_backward: and download the images. paste the folder in public/images. The directory tree should be like this

```sh
SQuirreL/
├─ middlewares/
├─ public/
│ ├─ css/
│ ├─ images/
│ │ ├─ books/
│ │ │ ├─ 10000001.jpg
│ │ │ ├─ 10000002.jpg
│ │ │ ├─ ...
│ │ ├─ favicon.png
│ │ ├─ ...
│ ├─ scripts/
├─ router/

```

We are finally good to go

#### Run the project

Go to your favourite code editor and run

```sh
npm run dev
```

You should find that the project is working!

(back to top)

## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

(back to top)

## Contributors

- **Md. Tamimul Ehsan** - 1805022

- **Sachin Deb** - 1805020

## Supervisor

- Dr. Rifat Shahriyar (রিফাত শাহরিয়ার)

- **Professor**

:arrow_forward: **Contact:**

Department of Computer Science and Engineering
Bangladesh University of Engineering and Technology
Dhaka-1000, Bangladesh

:arrow_forward: **Homepage:**

[http://rifatshahriyar.github.io/](http://rifatshahriyar.github.io/)

(back to top)