iwish-cdd-frontend

v0.1.0

Published

a year ago

Downloads

0High
0Medium
0Low

mehrshad0289

iwish-frontend(CDD)

About The Project

Redesigned IWish front-end with component-driven architecture. Optimized for maintainability and scalability. This repository contains the front-end code for the redesign of the IWish application using a component-driven development architecture. Our goal is to provide an intuitive and visually appealing user interface for our users while maintaining a modular and scalable codebase. By adopting this architecture, we aim to improve code reusability, reduce redundancy, and enhance collaboration among developers. Our components are designed with flexibility in mind, allowing for easy customization and integration into other projects.

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

this is an example of how to list things you need to use the software and how to install them.

LEMP stack

and these

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

Create or edit the config file of nginx

dirname="iwishmenu"
nano /etc/nginx/conf.d/$dirname.conf
sudo systemctl restart nginx

the file should be as follows:

server {
   server_name   iwishmenu.ir;

   location / {
     proxy_pass             http://127.0.0.1:3000;
     proxy_read_timeout     60;
     proxy_connect_timeout  60;
     proxy_redirect         off;
  
     # Allow the use of websockets
     proxy_http_version 1.1;
     proxy_set_header Upgrade $http_upgrade;
     proxy_set_header Connection 'upgrade';
     proxy_set_header Host $host;
     proxy_cache_bypass $http_upgrade;
   }

}

Clone the repo

git clone -b development https://github.com/iwishco/iwish-CDD-frontend.git /var/www/$dirname/domain

Install NPM packages
```
cd /var/www/$dirname
npm install
```

Set the environment variables. Enter your API in config.js

cd /var/www/$dirname
cp config.env.example config.env
nano config.env

then please set the variables.

const API_KEY = 'ENTER YOUR API';

Set the port in the package.json file ??????

 "scripts": { 
    "dev": "next dev -p 8080",
    "start": "next start -p 8080",
 },

Build the project

npm run build
pm2 start npm --name "cactusmenu" -- start
pm2 save

pm2 start npm --name "cactusmenu" -- run dev
pm2 save

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

Updates

Update the source

dirname="music1"
cd /var/www/$dirname
git pull

Install NPM packages
```
npm install
```

Build the project

npm run build
rm -r public_html
cp build public_html

For more examples, please refer to the Documentation

Local developement

startup

if this is the first time you cloning this repo you need to install packages with command

npm i

This is a Next.js project bootstrapped with create-next-app.

run the app

npm run dev

to start a development server and you can see the result in http://localhost:3000.

story book

the project uses component driven development for that cause some tools required in devlop process like story book

npm run storybook

this command starts a story book project in 'this link' feel free to see documentation of components and edit them in the story book without to need run the whole app

Roadmap

[x] Add Changelog
[x] Add back to top links
[ ] Add Additional Templates w/ Examples
[ ] Add "components" document to easily copy & paste sections of the readme
[ ] Multi-language Support
- [ ] Chinese
- [ ] Spanish

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

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

Contact

Your Name - @your_twitter - [email protected]

Project Link: https://github.com/your_username/repo_name

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!