Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 0 additions & 45 deletions .eslintrc.json

This file was deleted.

20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,30 @@
# Smatter 🚀

// git push smatter-push

## What is Smatter?

Smatter is a Twitter-like social media page. We use it as a code base for applicants to complete tasks as part of the interview process.
Smatter is a Twitter-like social media page.

## Tech Stack

Theres a frontend package and a backend package. The frontend is built with React with Vite, and the backend is a web API built with Node.js and Express. The backend uses a MongoDB database.
--

## Development Setup

1. **Install Dependencies**\
Run the following command in the project root, and in each package

```bash
npm install
```
--

2. **Start the Database**\
Run the following command in the backend package to start your database in a Docker container:
Run the following command to start your database in a Docker container:

```bash
npm run start-db
// TODO
```

3. **Start the App**\
Run the following command in the project root to start both the backend and frontend:

```bash
npm run dev
// TODO
```

The frontend is served on port 5173, and the API can be accessed on port 3001.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading