Skip to content

Commit 3629101

Browse files
committed
Update README
1 parent 828c702 commit 3629101

1 file changed

Lines changed: 28 additions & 21 deletions

File tree

README.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
# Salt eCommerce Task
1+
# fsharp-ecommerce
22

3-
This is a task for Salt in which a basic clone of an ecommerce website has been made. One can view products and add/remove them from the cart. One can search for products by name.
4-
![Salt eCommerce Preview](https://i.ibb.co/71D3XCW/Screenshot-2020-08-12-at-18-45-45.png)
3+
A full-stack ecommerce prototype featuring product browsing, cart management, and search. Built with an F#/Giraffe REST API and a React/Redux frontend, backed by MongoDB.
4+
5+
![eCommerce Preview](https://i.ibb.co/71D3XCW/Screenshot-2020-08-12-at-18-45-45.png)
56

67
---
78

89
## Backend
910

10-
The backend was written with the help of the following technologies:
11-
1211
- F#
1312
- Giraffe
1413
- MongoDB
@@ -17,26 +16,34 @@ The backend was written with the help of the following technologies:
1716

1817
## Frontend
1918

20-
The frontend was written with the help of the following technologies:
21-
2219
- JavaScript
2320
- React
2421
- Redux
2522
- Ant Design
2623

2724
---
2825

29-
### How to run
30-
31-
This project requires the installation of MongoDB, a dotnet environment and a JS package manager such as npm or yarn.
32-
33-
- Clone this repo to your desktop
34-
- Export the MongoDB environment variable
35-
- `export MONGO_URL=mongodb://localhost:27017/`
36-
- Import the CSV file to MongoDB, openfoodfacts.csv has had the 'code' column changed to \_id
37-
- `mongoimport --type tsv --db products -c products --ignoreBlanks --fieldFile=fieldtypes.txt --columnsHaveTypes --drop openfoodfacts.csv`
38-
- cd into the Backend folder and start the F# API
39-
- `dotnet run`
40-
- cd into the Frontend/salt-frontend/ and start the frontend
41-
- First `yarn install`
42-
- Then `yarn start`
26+
## How to run
27+
28+
Prerequisites: MongoDB, .NET SDK, and a JS package manager (npm or yarn).
29+
30+
1. Clone this repo
31+
2. Export the MongoDB environment variable
32+
```
33+
export MONGO_URL=mongodb://localhost:27017/
34+
```
35+
3. Import the product data into MongoDB (`openfoodfacts.csv` has had the `code` column changed to `_id`)
36+
```
37+
mongoimport --type tsv --db products -c products --ignoreBlanks --fieldFile=fieldtypes.txt --columnsHaveTypes --drop openfoodfacts.csv
38+
```
39+
4. Start the backend
40+
```
41+
cd Backend
42+
dotnet run
43+
```
44+
5. Start the frontend
45+
```
46+
cd Frontend/salt-frontend
47+
yarn install
48+
yarn start
49+
```

0 commit comments

Comments
 (0)