Skip to content

Commit

Permalink
Fix the main README
Browse files Browse the repository at this point in the history
  • Loading branch information
ivantha committed Mar 21, 2022
1 parent 2b8f504 commit ff2f266
Showing 1 changed file with 1 addition and 68 deletions.
69 changes: 1 addition & 68 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,74 +8,7 @@
TensorMap is a web application that will allow the users to create machine learning algorithms visually. TensorMap supports reverse engineering of the visual layout to a Tensorflow implementation in preferred languages. The goal of the project is to let the beginners play with machine learning algorithms in Tensorflow without less background knowledge about the library. For more details about the project, read our [project wiki.](https://github.com/scorelab/TensorMap/wiki)

## Getting Started
Follow these steps to set up TensorMap on your local machine.

First clone this repo by running
```bash

git clone https://github.com/scorelab/TensorMap.git
```````````````````````````

### Setting up Frontend

#### Prerequisites
* Node.js
* Yarn
* Npm

```bash
cd TensorMap
cd tensormap-client
yarn install
npm start
```

### Setting up Backend

First make sure you have MySQL server and Python 3.x installed in your system.

Then, go into 'tensormap-server' folder

```bash
cd TensorMap
cd tensormap-server
```

Then, install all the required packages by running

```bash
pip install -r requirements.txt
```

Next, login to MySQL and create a database named 'tensormap'

```bash
mysql -u <user> -p
CREATE DATABASE tensormap;
```

Then in the '__init__' file that is inside the 'app' folder, replace the database connection string with your username and password

```bash
app.config['SQLALCHEMY_DATABASE_URI'] = "mysql://<user>:<password>@localhost/tensormap"
```

Next, restore the sql dump
```bash
mysql -u {user} -p -Dtensormap < {path-to-dump-file}/dump.sql
```

To start the server run

```bash
python run.py
```

## Built With

* [Reactjs](https://reactjs.org/docs/getting-started.html) : Frontend
* [Flask](http://flask.pocoo.org/) : Backend
* [TensorFlow - Keras](https://www.tensorflow.org/) : Model implemetation
Follow these steps the steps in the `tensormap-server` and `tensormap-client` directories to setup each component.

## Contributing

Expand Down

0 comments on commit ff2f266

Please sign in to comment.