aimimi

The project’s objective is to develop a platform for people who are hoping to crush their goals. The core feature of the platform is goal tracking, also with some other features like goal sharing, leaderboard, social networking service, etc.

aimimi.herokuapp.com/

📁 File Structure

.
├── client
│   ├── node_modules
│   ├── public
│   ├── src
│   │   ├── components
│   │   ├── contexts
│   │   ├── views
│   │   ├── App.jsx
│   │   ├── index.jsx
|   ├── package.json
│   ├── yarn.lock
│   ├── README.md
├── server
│   ├── api
│   │   ├── controllers
│   │   ├── middleware
│   │   ├── models
│   │   ├── routes
│   ├── index.js
|   ├── package.json
│   ├── yarn.lock
│   ├── README.md
├── .gitignore
├── package.json
├── yarn.lock
├── README.md

💅🏻 Frontend Development

Aimimi is a web application, also a progressive web application (PWA) for mobile users. We are going to use react for our front-end development.

Also, we are planning to use the react-bootstrap and styled-component in developing user interfaces. We hope to provide users with an user-friendly, responsive, and high performance experience for reaching their goals.

Please read README.md for more details about frontend.

🛡️ Backend Development

Our backend development mainly focuses on the database management and the request and response between our data and server. Beside, we decided to use the following tools for backend development:

MongoDB

It is an aggregation framework that provides a secure and NoSQL database that can scale to a high level of write and read traffic. Moreover, it allows scaling across or within multiple distributed data centers. With its document based feature, it can provide a better availability and scalability than other database management systems.

Express

We designed Express as the Node.js web framework, which provides mechanisms to integrate with rendering engines that can generate responses by inserting data from MongoDB. Also, at different URL paths, Express allows writing handlers for requests with HTTP verbs, providing RESTful API for frontend.

Please read README.md for more details about backend.

🎯 Progress

Responsive user interface
User system (Signup, Login, Logout)
View user's goals, adding a goal
Deployed on Heroku

🥁 Contributors


IamMrandrew	thomas2050	JustinWaterWater	janson0004	khchoi0

🚀 Run it locally

Run the following commands:

Make sure you have yarn installed

git clone https://github.com/IamMrandrew/aimimi.git

client

Navigate to client folder, install dependencies

cd client
yarn install

Start the client side

yarn start

server

Navigate to server folder, install dependencies

cd server
yarn install

Create an config folder under the server folder, put .env file. and 'test.env' inside and set the environment variable:

PORT=3001
MONGO_URL=your_own_mongodb_uri
NODE_ENV=development
JTW_TOKEN=your_token
GMAIL_ACCOUNT=mail_account
GMAIL_PASSWORD=mail_password

Start the server side

yarn start